com.google.cloud.pubsub.v1.stub

Class PublisherStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<PublisherStubSettings>

com.google.cloud.pubsub.v1.stub.PublisherStubSettings

@Generated(value="by gapic-generator")
public class PublisherStubSettings
extends StubSettings<PublisherStubSettings>

Settings class to configure an instance of PublisherStub.

The default instance has everything set to sensible defaults:

• The default service address (pubsub.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object. For example, to set the total timeout of createTopic to 30 seconds:

 
 PublisherStubSettings.Builder topicAdminSettingsBuilder =
     PublisherStubSettings.newBuilder();
 topicAdminSettingsBuilder.createTopicSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 PublisherStubSettings topicAdminSettings = topicAdminSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublisherStubSettings.Builder Builder for PublisherStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PublisherStubSettings(PublisherStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
PublisherStub	createStub()
UnaryCallSettings<com.google.pubsub.v1.Topic,com.google.pubsub.v1.Topic>	createTopicSettings() Returns the object with the settings used for calls to createTopic.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.pubsub.v1.DeleteTopicRequest,Empty>	deleteTopicSettings() Returns the object with the settings used for calls to deleteTopic.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<com.google.pubsub.v1.GetTopicRequest,com.google.pubsub.v1.Topic>	getTopicSettings() Returns the object with the settings used for calls to getTopic.
PagedCallSettings<com.google.pubsub.v1.ListTopicsRequest,com.google.pubsub.v1.ListTopicsResponse,TopicAdminClient.ListTopicsPagedResponse>	listTopicsSettings() Returns the object with the settings used for calls to listTopics.
PagedCallSettings<com.google.pubsub.v1.ListTopicSubscriptionsRequest,com.google.pubsub.v1.ListTopicSubscriptionsResponse,TopicAdminClient.ListTopicSubscriptionsPagedResponse>	listTopicSubscriptionsSettings() Returns the object with the settings used for calls to listTopicSubscriptions.
static PublisherStubSettings.Builder	newBuilder() Returns a new builder for this class.
static PublisherStubSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
BatchingCallSettings<com.google.pubsub.v1.PublishRequest,com.google.pubsub.v1.PublishResponse>	publishSettings() Returns the object with the settings used for calls to publish.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
PublisherStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.pubsub.v1.UpdateTopicRequest,com.google.pubsub.v1.Topic>	updateTopicSettings() Returns the object with the settings used for calls to updateTopic.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PublisherStubSettings

protected PublisherStubSettings(PublisherStubSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

createTopicSettings

public UnaryCallSettings<com.google.pubsub.v1.Topic,com.google.pubsub.v1.Topic> createTopicSettings()

Returns the object with the settings used for calls to createTopic.

updateTopicSettings

public UnaryCallSettings<com.google.pubsub.v1.UpdateTopicRequest,com.google.pubsub.v1.Topic> updateTopicSettings()

Returns the object with the settings used for calls to updateTopic.

publishSettings

public BatchingCallSettings<com.google.pubsub.v1.PublishRequest,com.google.pubsub.v1.PublishResponse> publishSettings()

Returns the object with the settings used for calls to publish.

getTopicSettings

public UnaryCallSettings<com.google.pubsub.v1.GetTopicRequest,com.google.pubsub.v1.Topic> getTopicSettings()

Returns the object with the settings used for calls to getTopic.

listTopicsSettings

public PagedCallSettings<com.google.pubsub.v1.ListTopicsRequest,com.google.pubsub.v1.ListTopicsResponse,TopicAdminClient.ListTopicsPagedResponse> listTopicsSettings()

Returns the object with the settings used for calls to listTopics.

listTopicSubscriptionsSettings

public PagedCallSettings<com.google.pubsub.v1.ListTopicSubscriptionsRequest,com.google.pubsub.v1.ListTopicSubscriptionsResponse,TopicAdminClient.ListTopicSubscriptionsPagedResponse> listTopicSubscriptionsSettings()

Returns the object with the settings used for calls to listTopicSubscriptions.

deleteTopicSettings

public UnaryCallSettings<com.google.pubsub.v1.DeleteTopicRequest,Empty> deleteTopicSettings()

Returns the object with the settings used for calls to deleteTopic.

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

createStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public PublisherStub createStub()
                                                                                                                       throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static PublisherStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static PublisherStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public PublisherStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class StubSettings<PublisherStubSettings>