Class Publisher.Builder (1.133.0) 

public static final class Publisher.Builder

A builder of Publishers.

Inheritance

java.lang.Object > Publisher.Builder

Static Methods

getDefaultBatchingSettings()

public static BatchingSettings getDefaultBatchingSettings()

Returns the default BatchingSettings used by the client if settings are not provided.

Returns
Type Description
BatchingSettings

Methods

build()

public Publisher build()
Returns
Type Description
Publisher
Exceptions
Type Description
IOException

setBatchingSettings(BatchingSettings batchingSettings)

public Publisher.Builder setBatchingSettings(BatchingSettings batchingSettings)
Parameter
Name Description
batchingSettings BatchingSettings
Returns
Type Description
Publisher.Builder

setChannelProvider(TransportChannelProvider channelProvider)

public Publisher.Builder setChannelProvider(TransportChannelProvider channelProvider)

ChannelProvider to use to create Channels, which must point at Cloud Pub/Sub endpoint.

For performance, this client benefits from having multiple underlying connections. See com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder#setPoolSize(int).

Parameter
Name Description
channelProvider TransportChannelProvider
Returns
Type Description
Publisher.Builder

setCompressionBytesThreshold(long compressionBytesThreshold)

public Publisher.Builder setCompressionBytesThreshold(long compressionBytesThreshold)

Sets the threshold (in bytes) above which messages are compressed for transport. Only takes effect if setEnableCompression(true) is also called."

Parameter
Name Description
compressionBytesThreshold long
Returns
Type Description
Publisher.Builder

setCredentialsProvider(CredentialsProvider credentialsProvider)

public Publisher.Builder setCredentialsProvider(CredentialsProvider credentialsProvider)

CredentialsProvider to use to create Credentials to authenticate calls.

Parameter
Name Description
credentialsProvider CredentialsProvider
Returns
Type Description
Publisher.Builder

setEnableCompression(boolean enableCompression)

public Publisher.Builder setEnableCompression(boolean enableCompression)

Gives the ability to enable transport compression.

Parameter
Name Description
enableCompression boolean
Returns
Type Description
Publisher.Builder

setEnableMessageOrdering(boolean enableMessageOrdering)

public Publisher.Builder setEnableMessageOrdering(boolean enableMessageOrdering)

Sets the message ordering option.

Parameter
Name Description
enableMessageOrdering boolean
Returns
Type Description
Publisher.Builder

setEnableOpenTelemetryTracing(boolean enableOpenTelemetryTracing)

public Publisher.Builder setEnableOpenTelemetryTracing(boolean enableOpenTelemetryTracing)

Gives the ability to enable Open Telemetry Tracing

Parameter
Name Description
enableOpenTelemetryTracing boolean
Returns
Type Description
Publisher.Builder

setEndpoint(String endpoint)

public Publisher.Builder setEndpoint(String endpoint)

Gives the ability to override the gRPC endpoint.

Parameter
Name Description
endpoint String
Returns
Type Description
Publisher.Builder

setExecutorProvider(ExecutorProvider executorProvider)

public Publisher.Builder setExecutorProvider(ExecutorProvider executorProvider)

Gives the ability to set a custom executor to be used by the library.

Parameter
Name Description
executorProvider ExecutorProvider
Returns
Type Description
Publisher.Builder

setHeaderProvider(HeaderProvider headerProvider)

public Publisher.Builder setHeaderProvider(HeaderProvider headerProvider)

Sets the static header provider. The header provider will be called during client construction only once. The headers returned by the provider will be cached and supplied as is for each request issued by the constructed client. Some reserved headers can be overridden (e.g. Content-Type) or merged with the default value (e.g. User-Agent) by the underlying transport layer.

Parameter
Name Description
headerProvider HeaderProvider

the header provider
Returns
Type Description
Publisher.Builder

the builder

setOpenTelemetry(OpenTelemetry openTelemetry)

public Publisher.Builder setOpenTelemetry(OpenTelemetry openTelemetry)

Sets the instance of OpenTelemetry for the Publisher class.

Parameter
Name Description
openTelemetry io.opentelemetry.api.OpenTelemetry
Returns
Type Description
Publisher.Builder

setRetrySettings(RetrySettings retrySettings)

public Publisher.Builder setRetrySettings(RetrySettings retrySettings)

Configures the Publisher's retry parameters.

Parameter
Name Description
retrySettings RetrySettings
Returns
Type Description
Publisher.Builder

setTransform(ApiFunction<PubsubMessage,PubsubMessage> messageTransform)

public Publisher.Builder setTransform(ApiFunction<PubsubMessage,PubsubMessage> messageTransform)

Gives the ability to set an ApiFunction that will transform the PubsubMessage before it is sent

Parameter
Name Description
messageTransform ApiFunction<PubsubMessage,PubsubMessage>
Returns
Type Description
Publisher.Builder

setUniverseDomain(String universeDomain)

public Publisher.Builder setUniverseDomain(String universeDomain)

Gives the ability to override the universe domain.

Parameter
Name Description
universeDomain String
Returns
Type Description
Publisher.Builder