Package com.google.cloud.pubsub.v1
Class Publisher.Builder
java.lang.Object
com.google.cloud.pubsub.v1.Publisher.Builder
- Enclosing class:
- Publisher
A builder of
Publisher
s.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static com.google.api.gax.batching.BatchingSettings
Returns the default BatchingSettings used by the client if settings are not provided.setBatchingSettings
(com.google.api.gax.batching.BatchingSettings batchingSettings) setChannelProvider
(com.google.api.gax.rpc.TransportChannelProvider channelProvider) ChannelProvider
to use to create Channels, which must point at Cloud Pub/Sub endpoint.setCompressionBytesThreshold
(long compressionBytesThreshold) Sets the threshold (in bytes) above which messages are compressed for transport.setCredentialsProvider
(com.google.api.gax.core.CredentialsProvider credentialsProvider) CredentialsProvider
to use to create Credentials to authenticate calls.setEnableCompression
(boolean enableCompression) Gives the ability to enable transport compression.setEnableMessageOrdering
(boolean enableMessageOrdering) Sets the message ordering option.setEndpoint
(String endpoint) Gives the ability to override the gRPC endpoint.setExecutorProvider
(com.google.api.gax.core.ExecutorProvider executorProvider) Gives the ability to set a custom executor to be used by the library.setHeaderProvider
(com.google.api.gax.rpc.HeaderProvider headerProvider) Sets the static header provider.setRetrySettings
(com.google.api.gax.retrying.RetrySettings retrySettings) Configures the Publisher's retry parameters.setTransform
(com.google.api.core.ApiFunction<PubsubMessage, PubsubMessage> messageTransform) Gives the ability to set anApiFunction
that will transform thePubsubMessage
before it is sent
-
Method Details
-
setChannelProvider
public Publisher.Builder setChannelProvider(com.google.api.gax.rpc.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
InstantiatingGrpcChannelProvider.Builder.setPoolSize(int)
. -
setHeaderProvider
@BetaApi public Publisher.Builder setHeaderProvider(com.google.api.gax.rpc.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.- Parameters:
headerProvider
- the header provider- Returns:
- the builder
-
setCredentialsProvider
public Publisher.Builder setCredentialsProvider(com.google.api.gax.core.CredentialsProvider credentialsProvider) CredentialsProvider
to use to create Credentials to authenticate calls. -
setBatchingSettings
public Publisher.Builder setBatchingSettings(com.google.api.gax.batching.BatchingSettings batchingSettings) -
setRetrySettings
Configures the Publisher's retry parameters. -
setEnableMessageOrdering
Sets the message ordering option. -
setExecutorProvider
public Publisher.Builder setExecutorProvider(com.google.api.gax.core.ExecutorProvider executorProvider) Gives the ability to set a custom executor to be used by the library. -
setTransform
@BetaApi public Publisher.Builder setTransform(com.google.api.core.ApiFunction<PubsubMessage, PubsubMessage> messageTransform) Gives the ability to set anApiFunction
that will transform thePubsubMessage
before it is sent -
setEndpoint
Gives the ability to override the gRPC endpoint. -
setEnableCompression
Gives the ability to enable transport compression. -
setCompressionBytesThreshold
Sets the threshold (in bytes) above which messages are compressed for transport. Only takes effect if setEnableCompression(true) is also called." -
getDefaultBatchingSettings
public static com.google.api.gax.batching.BatchingSettings getDefaultBatchingSettings()Returns the default BatchingSettings used by the client if settings are not provided. -
build
- Throws:
IOException
-