Package org.apache.beam.sdk.io.gcp.pubsub

Interface PubsubClient.PubsubClientFactory

All Superinterfaces:

Serializable

All Known Subinterfaces:

PubsubTestClient.PubsubTestClientFactory

Enclosing class:

PubsubClient

public static interface PubsubClient.PubsubClientFactory
extends Serializable

Factory for creating clients.

Method Summary

Modifier and Type	Method	Description
String	getKind()	Return the display name for this factory.
PubsubClient	newClient(@Nullable String timestampAttribute, @Nullable String idAttribute, PubsubOptions options)
PubsubClient	newClient(@Nullable String timestampAttribute, @Nullable String idAttribute, PubsubOptions options, @Nullable String rootUrlOverride)	Construct a new Pubsub client.

Method Details

newClient

PubsubClient newClient(@Nullable String timestampAttribute,
 @Nullable String idAttribute,
 PubsubOptions options,
 @Nullable String rootUrlOverride)
                throws IOException

Construct a new Pubsub client. It should be closed via Closeable.close() in order to ensure tidy cleanup of underlying netty resources (or use the try-with-resources construct). Uses options to derive pubsub endpoints and application credentials. If non-null, use timestampAttribute and idAttribute to store custom timestamps/ids within message metadata.

Throws:

IOException

newClient

PubsubClient newClient(@Nullable String timestampAttribute,
 @Nullable String idAttribute,
 PubsubOptions options)
                throws IOException

Throws:

IOException

getKind

String getKind()

Return the display name for this factory. Eg "Json", "gRPC".