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

Class PubSubSource.PubSubSourceBuilder<OUT>

java.lang.Object

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

Type Parameters:

OUT - The type of objects which will be read

All Implemented Interfaces:

PubSubSource.ProjectNameBuilder<OUT>, PubSubSource.SubscriptionNameBuilder<OUT>

Enclosing class:

PubSubSource<OUT>

public static class PubSubSource.PubSubSourceBuilder<OUT>
extends Object
implements PubSubSource.ProjectNameBuilder<OUT>, PubSubSource.SubscriptionNameBuilder<OUT>

Builder to create PubSubSource.

Method Summary

Modifier and Type	Method and Description
PubSubSource<OUT>	build() Actually build the desired instance of the PubSubSourceBuilder.
PubSubSource.PubSubSourceBuilder<OUT>	withCredentials(com.google.auth.Credentials credentials) Set the credentials.
PubSubSource.PubSubSourceBuilder<OUT>	withMessageRateLimit(int messagePerSecondRateLimit) Set a limit on the rate of messages per second received.
PubSubSource.SubscriptionNameBuilder<OUT>	withProjectName(String projectName) Set the project name of the subscription to pull messages from.
PubSubSource.PubSubSourceBuilder<OUT>	withPubSubSubscriberFactory(int maxMessagesPerPull, java.time.Duration perRequestTimeout, int retries) There is a default PubSubSubscriber factory that uses gRPC to pull in PubSub messages.
PubSubSource.PubSubSourceBuilder<OUT>	withPubSubSubscriberFactory(PubSubSubscriberFactory pubSubSubscriberFactory) Set a PubSubSubscriberFactory This allows for custom Subscriber options to be set.
PubSubSource.PubSubSourceBuilder<OUT>	withSubscriptionName(String subscriptionName) Set the subscription name of the subscription to pull messages from.

Methods inherited from class java.lang.Object

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

Method Detail

withProjectName

public PubSubSource.SubscriptionNameBuilder<OUT> withProjectName(String projectName)

Description copied from interface: PubSubSource.ProjectNameBuilder

Set the project name of the subscription to pull messages from.

Specified by:

withProjectName in interface PubSubSource.ProjectNameBuilder<OUT>

withSubscriptionName

public PubSubSource.PubSubSourceBuilder<OUT> withSubscriptionName(String subscriptionName)

Description copied from interface: PubSubSource.SubscriptionNameBuilder

Set the subscription name of the subscription to pull messages from.

Specified by:

withSubscriptionName in interface PubSubSource.SubscriptionNameBuilder<OUT>

withCredentials

public PubSubSource.PubSubSourceBuilder<OUT> withCredentials(com.google.auth.Credentials credentials)

Set the credentials. If this is not used then the credentials are picked up from the environment variables.

Parameters:

credentials - the Credentials needed to connect.

Returns:

The current PubSubSourceBuilder instance

withPubSubSubscriberFactory

public PubSubSource.PubSubSourceBuilder<OUT> withPubSubSubscriberFactory(PubSubSubscriberFactory pubSubSubscriberFactory)

Set a PubSubSubscriberFactory This allows for custom Subscriber options to be set. DefaultPubSubSubscriberFactory is the default.

Parameters:

pubSubSubscriberFactory - A factory to create a Subscriber

Returns:

The current PubSubSourceBuilder instance

withPubSubSubscriberFactory

public PubSubSource.PubSubSourceBuilder<OUT> withPubSubSubscriberFactory(int maxMessagesPerPull,
                                                                         java.time.Duration perRequestTimeout,
                                                                         int retries)

There is a default PubSubSubscriber factory that uses gRPC to pull in PubSub messages. This method can be used to tune this default factory. Note this will not work in combination with a custom PubSubSubscriber factory.

Parameters:

maxMessagesPerPull - the number of messages pulled per request. Default: 100

perRequestTimeout - the timeout per request. Default: 15 seconds

retries - the number of retries when requests fail

Returns:

The current PubSubSourceBuilder instance

withMessageRateLimit

public PubSubSource.PubSubSourceBuilder<OUT> withMessageRateLimit(int messagePerSecondRateLimit)

Set a limit on the rate of messages per second received. This limit is per parallel instance of the source function. Default is set to 100000 messages per second.

Parameters:

messagePerSecondRateLimit - the message per second rate limit.

build

public PubSubSource<OUT> build()
                        throws IOException

Actually build the desired instance of the PubSubSourceBuilder.

Returns:

a brand new SourceFunction

Throws:

IOException - in case of a problem getting the credentials

IllegalArgumentException - in case required fields were not specified.