com.google.cloud.pubsub.spi.v1

Class PublisherSettings.Builder

java.lang.Object

com.google.api.gax.grpc.ServiceApiSettings.Builder

com.google.cloud.pubsub.spi.v1.PublisherSettings.Builder

Enclosing class:

PublisherSettings

public static class PublisherSettings.Builder
extends ServiceApiSettings.Builder

Builder for PublisherSettings.

Method Summary

Modifier and Type	Method and Description
PublisherSettings.Builder	applyToAllApiMethods(ApiCallSettings.Builder apiCallSettings) Applies the given settings to all of the API methods in this service.
PublisherSettings	build()
SimpleCallSettings.Builder<Topic,Topic>	createTopicSettings() Returns the builder for the settings used for calls to createTopic.
SimpleCallSettings.Builder<DeleteTopicRequest,Empty>	deleteTopicSettings() Returns the builder for the settings used for calls to deleteTopic.
SimpleCallSettings.Builder<GetTopicRequest,Topic>	getTopicSettings() Returns the builder for the settings used for calls to getTopic.
PageStreamingCallSettings.Builder<ListTopicsRequest,ListTopicsResponse,Topic>	listTopicsSettings() Returns the builder for the settings used for calls to listTopics.
PageStreamingCallSettings.Builder<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,java.lang.String>	listTopicSubscriptionsSettings() Returns the builder for the settings used for calls to listTopicSubscriptions.
PublisherSettings.Builder	provideChannelWith(ConnectionSettings settings) Provides the connection settings necessary to create a channel.
PublisherSettings.Builder	provideChannelWith(com.google.auth.Credentials credentials) Provides the credentials necessary to create a channel.
PublisherSettings.Builder	provideChannelWith(java.util.List<java.lang.String> scopes) Provides a list of scopes that will be applied to the credentials used to create a channel.
PublisherSettings.Builder	provideChannelWith(io.grpc.ManagedChannel channel, boolean shouldAutoClose) Sets a channel for this ServiceApiSettings to use.
PublisherSettings.Builder	provideExecutorWith(java.util.concurrent.ScheduledExecutorService executor, boolean shouldAutoClose) Sets the executor to use for channels, retries, and bundling.
BundlingCallSettings.Builder<PublishRequest,PublishResponse>	publishSettings() Returns the builder for the settings used for calls to publish.
PublisherSettings.Builder	setClientLibHeader(java.lang.String name, java.lang.String version) Sets the client library name and version for the GRPC custom header.
PublisherSettings.Builder	setGeneratorHeader(java.lang.String name, java.lang.String version) Sets the generator name and version for the GRPC custom header.

Methods inherited from class com.google.api.gax.grpc.ServiceApiSettings.Builder

getChannelProvider, getClientLibName, getClientLibVersion, getExecutorProvider, getGeneratorName, getGeneratorVersion

Methods inherited from class java.lang.Object

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

Method Detail

provideExecutorWith

public PublisherSettings.Builder provideExecutorWith(java.util.concurrent.ScheduledExecutorService executor,
                                                     boolean shouldAutoClose)

Description copied from class: ServiceApiSettings.Builder

Sets the executor to use for channels, retries, and bundling. If multiple Api objects will use this executor, shouldAutoClose must be set to false to prevent the ExecutorProvider from throwing an IllegalStateException. See ExecutorProvider for more details.

Overrides:

provideExecutorWith in class ServiceApiSettings.Builder

provideChannelWith

public PublisherSettings.Builder provideChannelWith(io.grpc.ManagedChannel channel,
                                                    boolean shouldAutoClose)

Description copied from class: ServiceApiSettings.Builder

Sets a channel for this ServiceApiSettings to use. This prevents a channel from being created. This will overwrite any previous calls to provideChannelWith, including calls providing ConnectionSettings or Credentials. See class documentation for more details on channels. If multiple Api objects will use this channel, shouldAutoClose must be set to false to prevent the ChannelProvider from throwing an IllegalStateException. See ChannelProvider for more details.

Overrides:

provideChannelWith in class ServiceApiSettings.Builder

provideChannelWith

public PublisherSettings.Builder provideChannelWith(ConnectionSettings settings)

Description copied from class: ServiceApiSettings.Builder

Provides the connection settings necessary to create a channel. This will overwrite any previous calls to provideChannelWith, including calls providing Credentials or a ManagedChannel.

Overrides:

provideChannelWith in class ServiceApiSettings.Builder

provideChannelWith

public PublisherSettings.Builder provideChannelWith(com.google.auth.Credentials credentials)

Description copied from class: ServiceApiSettings.Builder

Provides the credentials necessary to create a channel. Other settings required to create the channel will be set to the defaults for the service. This will overwrite any previous calls to provideChannelWith, including calls providing ConnectionSettings or a ManagedChannel.

Overrides:

provideChannelWith in class ServiceApiSettings.Builder

provideChannelWith

public PublisherSettings.Builder provideChannelWith(java.util.List<java.lang.String> scopes)

Description copied from class: ServiceApiSettings.Builder

Provides a list of scopes that will be applied to the credentials used to create a channel. The credentials will be acquired using Application Default Credentials, and the scopes will be applied to the result if that is required from the type of credentials. Other settings required to create the channel will be set to the defaults for the service. This will overwrite any previous calls to provideChannelWith, including calls providing ConnectionSettings or a ManagedChannel.

Overrides:

provideChannelWith in class ServiceApiSettings.Builder

setGeneratorHeader

public PublisherSettings.Builder setGeneratorHeader(java.lang.String name,
                                                    java.lang.String version)

Description copied from class: ServiceApiSettings.Builder

Sets the generator name and version for the GRPC custom header.

Overrides:

setGeneratorHeader in class ServiceApiSettings.Builder

setClientLibHeader

public PublisherSettings.Builder setClientLibHeader(java.lang.String name,
                                                    java.lang.String version)

Description copied from class: ServiceApiSettings.Builder

Sets the client library name and version for the GRPC custom header.

Overrides:

setClientLibHeader in class ServiceApiSettings.Builder

applyToAllApiMethods

public PublisherSettings.Builder applyToAllApiMethods(ApiCallSettings.Builder apiCallSettings)
                                               throws java.lang.Exception

Applies the given settings to all of the API methods in this service. Only values that are non-null will be applied, so this method is not capable of un-setting any values.

Throws:

java.lang.Exception

createTopicSettings

public SimpleCallSettings.Builder<Topic,Topic> createTopicSettings()

Returns the builder for the settings used for calls to createTopic.

publishSettings

public BundlingCallSettings.Builder<PublishRequest,PublishResponse> publishSettings()

Returns the builder for the settings used for calls to publish.

getTopicSettings

public SimpleCallSettings.Builder<GetTopicRequest,Topic> getTopicSettings()

Returns the builder for the settings used for calls to getTopic.

listTopicsSettings

public PageStreamingCallSettings.Builder<ListTopicsRequest,ListTopicsResponse,Topic> listTopicsSettings()

Returns the builder for the settings used for calls to listTopics.

listTopicSubscriptionsSettings

public PageStreamingCallSettings.Builder<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,java.lang.String> listTopicSubscriptionsSettings()

Returns the builder for the settings used for calls to listTopicSubscriptions.

deleteTopicSettings

public SimpleCallSettings.Builder<DeleteTopicRequest,Empty> deleteTopicSettings()

Returns the builder for the settings used for calls to deleteTopic.

build

public PublisherSettings build()
                        throws java.io.IOException

Specified by:

build in class ServiceApiSettings.Builder

Throws:

java.io.IOException