org.apache.flink.streaming.connectors.gcp.pubsub

类 PubSubSource<OUT>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.source.RichSourceFunction<OUT>

org.apache.flink.streaming.connectors.gcp.pubsub.PubSubSource<OUT>

所有已实现的接口:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>, org.apache.flink.runtime.state.CheckpointListener, org.apache.flink.streaming.api.checkpoint.ListCheckpointed<AcknowledgeIdsForCheckpoint<String>>, org.apache.flink.streaming.api.functions.source.ParallelSourceFunction<OUT>, org.apache.flink.streaming.api.functions.source.SourceFunction<OUT>

public class PubSubSource<OUT>
extends org.apache.flink.streaming.api.functions.source.RichSourceFunction<OUT>
implements org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>, org.apache.flink.streaming.api.functions.source.ParallelSourceFunction<OUT>, org.apache.flink.runtime.state.CheckpointListener, org.apache.flink.streaming.api.checkpoint.ListCheckpointed<AcknowledgeIdsForCheckpoint<String>>

PubSub Source, this Source will consume PubSub messages from a subscription and Acknowledge them on the next checkpoint. This ensures every message will get acknowledged at least once.

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	PubSubSource.DeserializationSchemaBuilder Part of PubSubSource.PubSubSourceBuilder to set required fields.
static interface	PubSubSource.ProjectNameBuilder<OUT> Part of PubSubSource.PubSubSourceBuilder to set required fields.
static class	PubSubSource.PubSubSourceBuilder<OUT> Builder to create PubSubSource.
static interface	PubSubSource.SubscriptionNameBuilder<OUT> Part of PubSubSource.PubSubSourceBuilder to set required fields.

从接口继承的嵌套类/接口 org.apache.flink.streaming.api.functions.source.SourceFunction

org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<T>

字段概要

字段

限定符和类型	字段和说明
protected AcknowledgeOnCheckpoint<String>	acknowledgeOnCheckpoint
protected org.apache.flink.streaming.connectors.gcp.pubsub.PubSubSource.AcknowledgeOnCheckpointFactory	acknowledgeOnCheckpointFactory
protected com.google.auth.Credentials	credentials
protected PubSubDeserializationSchema<OUT>	deserializationSchema
protected boolean	isRunning
protected int	messagePerSecondRateLimit
protected PubSubSubscriberFactory	pubSubSubscriberFactory
protected org.apache.flink.api.common.io.ratelimiting.FlinkConnectorRateLimiter	rateLimiter
protected PubSubSubscriber	subscriber

方法概要

限定符和类型	方法和说明
void	cancel()
org.apache.flink.api.common.typeinfo.TypeInformation<OUT>	getProducedType()
static PubSubSource.DeserializationSchemaBuilder	newBuilder()
void	notifyCheckpointAborted(long checkpointId)
void	notifyCheckpointComplete(long checkpointId)
void	open(org.apache.flink.configuration.Configuration configuration)
void	restoreState(List<AcknowledgeIdsForCheckpoint<String>> state)
void	run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<OUT> sourceContext)
List<AcknowledgeIdsForCheckpoint<String>>	snapshotState(long checkpointId, long timestamp)

从类继承的方法 org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

deserializationSchema

protected final PubSubDeserializationSchema<OUT> deserializationSchema

pubSubSubscriberFactory

protected final PubSubSubscriberFactory pubSubSubscriberFactory

credentials

protected final com.google.auth.Credentials credentials

acknowledgeOnCheckpointFactory

protected final org.apache.flink.streaming.connectors.gcp.pubsub.PubSubSource.AcknowledgeOnCheckpointFactory acknowledgeOnCheckpointFactory

rateLimiter

protected final org.apache.flink.api.common.io.ratelimiting.FlinkConnectorRateLimiter rateLimiter

messagePerSecondRateLimit

protected final int messagePerSecondRateLimit

acknowledgeOnCheckpoint

protected transient AcknowledgeOnCheckpoint<String> acknowledgeOnCheckpoint

subscriber

protected transient PubSubSubscriber subscriber

isRunning

protected transient volatile boolean isRunning

方法详细资料

open

public void open(org.apache.flink.configuration.Configuration configuration)
          throws Exception

指定者:

open 在接口中 org.apache.flink.api.common.functions.RichFunction

覆盖:

open 在类中 org.apache.flink.api.common.functions.AbstractRichFunction

抛出:

Exception

run

public void run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<OUT> sourceContext)
         throws Exception

指定者:

run 在接口中 org.apache.flink.streaming.api.functions.source.SourceFunction<OUT>

抛出:

Exception

cancel

public void cancel()

指定者:

cancel 在接口中 org.apache.flink.streaming.api.functions.source.SourceFunction<OUT>

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<OUT> getProducedType()

指定者:

getProducedType 在接口中 org.apache.flink.api.java.typeutils.ResultTypeQueryable<OUT>

newBuilder

public static PubSubSource.DeserializationSchemaBuilder newBuilder()

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

指定者:

notifyCheckpointComplete 在接口中 org.apache.flink.runtime.state.CheckpointListener

抛出:

Exception

notifyCheckpointAborted

public void notifyCheckpointAborted(long checkpointId)

指定者:

notifyCheckpointAborted 在接口中 org.apache.flink.runtime.state.CheckpointListener

snapshotState

public List<AcknowledgeIdsForCheckpoint<String>> snapshotState(long checkpointId,
                                                               long timestamp)
                                                        throws Exception

指定者:

snapshotState 在接口中 org.apache.flink.streaming.api.checkpoint.ListCheckpointed<AcknowledgeIdsForCheckpoint<String>>

抛出:

Exception

restoreState

public void restoreState(List<AcknowledgeIdsForCheckpoint<String>> state)
                  throws Exception

指定者:

restoreState 在接口中 org.apache.flink.streaming.api.checkpoint.ListCheckpointed<AcknowledgeIdsForCheckpoint<String>>

抛出:

Exception