Package io.github.flink.gcp.connector.pubsub.source

Class PubSubSourceConfig<T>

java.lang.Object

io.github.flink.gcp.connector.pubsub.source.PubSubSourceConfig<T>

Type Parameters:

T - type of the records produced by the source

All Implemented Interfaces:

Serializable

@Internal
public final class PubSubSourceConfig<T>
extends Object
implements Serializable

Immutable configuration of a Pub/Sub source, assembled by PubSubSourceBuilder and shipped in the job graph.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Map<SubscriptionDestination,SubscriptionCreateOptions>	getCreateOptions()	Returns the settings each subscription is created with if it is absent, keyed by subscription.
DeserializationFailurePolicy	getDeserializationFailurePolicy()	Returns what to do with a message the deserialization schema cannot convert.
PubSubDeserializationSchema<T>	getDeserializationSchema()	Returns the deserialization schema.
EmulatorEndpoint	getEmulatorEndpoint()	Returns the emulator endpoint, or null for production Pub/Sub.
OrderingMode	getOrderingMode()	Returns the ordering mode.
String	getServiceAccountKeyFile()	Returns the service-account key-file path, or null for ADC.
PubSubStartPosition	getStartPosition()	Returns where the source starts consuming.
PubSubSubscriberOptions	getSubscriberOptions()	Returns the subscriber tuning options.
List<SubscriptionDestination>	getSubscriptions()	Returns the subscriptions to consume, in assignment order.

Methods inherited from class java.lang.Object

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

Method Details

getSubscriptions

public List<SubscriptionDestination> getSubscriptions()

Returns the subscriptions to consume, in assignment order.

getCreateOptions

public Map<SubscriptionDestination,SubscriptionCreateOptions> getCreateOptions()

Returns the settings each subscription is created with if it is absent, keyed by subscription. A subscription missing from this map must already exist.

getStartPosition

public PubSubStartPosition getStartPosition()

Returns where the source starts consuming.

getDeserializationSchema

public PubSubDeserializationSchema<T> getDeserializationSchema()

Returns the deserialization schema.

getOrderingMode

public OrderingMode getOrderingMode()

Returns the ordering mode.

getSubscriberOptions

public PubSubSubscriberOptions getSubscriberOptions()

Returns the subscriber tuning options.

getDeserializationFailurePolicy

public DeserializationFailurePolicy getDeserializationFailurePolicy()

Returns what to do with a message the deserialization schema cannot convert.

getServiceAccountKeyFile

@Nullable
public String getServiceAccountKeyFile()

Returns the service-account key-file path, or null for ADC.

getEmulatorEndpoint

@Nullable
public EmulatorEndpoint getEmulatorEndpoint()

Returns the emulator endpoint, or null for production Pub/Sub.