com.google.cloud.pubsub.v1

Class TopicAdminSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<TopicAdminSettings>

com.google.cloud.pubsub.v1.TopicAdminSettings

@Generated(value="by gapic-generator-java")
public class TopicAdminSettings
extends com.google.api.gax.rpc.ClientSettings<TopicAdminSettings>

Settings class to configure an instance of TopicAdminClient.

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:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TopicAdminSettings.Builder topicAdminSettingsBuilder = TopicAdminSettings.newBuilder();
 topicAdminSettingsBuilder
     .createTopicSettings()
     .setRetrySettings(
         topicAdminSettingsBuilder
             .createTopicSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TopicAdminSettings topicAdminSettings = topicAdminSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static TopicAdminSettings	create(PublisherStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<Topic,Topic>	createTopicSettings() Returns the object with the settings used for calls to createTopic.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteTopicRequest,com.google.protobuf.Empty>	deleteTopicSettings() Returns the object with the settings used for calls to deleteTopic.
com.google.api.gax.rpc.UnaryCallSettings<DetachSubscriptionRequest,DetachSubscriptionResponse>	detachSubscriptionSettings() Returns the object with the settings used for calls to detachSubscription.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetTopicRequest,Topic>	getTopicSettings() Returns the object with the settings used for calls to getTopic.
com.google.api.gax.rpc.PagedCallSettings<ListTopicSnapshotsRequest,ListTopicSnapshotsResponse,TopicAdminClient.ListTopicSnapshotsPagedResponse>	listTopicSnapshotsSettings() Returns the object with the settings used for calls to listTopicSnapshots.
com.google.api.gax.rpc.PagedCallSettings<ListTopicsRequest,ListTopicsResponse,TopicAdminClient.ListTopicsPagedResponse>	listTopicsSettings() Returns the object with the settings used for calls to listTopics.
com.google.api.gax.rpc.PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,TopicAdminClient.ListTopicSubscriptionsPagedResponse>	listTopicSubscriptionsSettings() Returns the object with the settings used for calls to listTopicSubscriptions.
static TopicAdminSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static TopicAdminSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static TopicAdminSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.BatchingCallSettings<PublishRequest,PublishResponse>	publishSettings() Returns the object with the settings used for calls to publish.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
TopicAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTopicRequest,Topic>	updateTopicSettings() Returns the object with the settings used for calls to updateTopic.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicAdminSettings

protected TopicAdminSettings(TopicAdminSettings.Builder settingsBuilder)
                      throws IOException

Throws:

IOException

Method Detail

createTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<Topic,Topic> createTopicSettings()

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

updateTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTopicRequest,Topic> updateTopicSettings()

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

publishSettings

public com.google.api.gax.rpc.BatchingCallSettings<PublishRequest,PublishResponse> publishSettings()

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

getTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTopicRequest,Topic> getTopicSettings()

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

listTopicsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTopicsRequest,ListTopicsResponse,TopicAdminClient.ListTopicsPagedResponse> listTopicsSettings()

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

listTopicSubscriptionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,TopicAdminClient.ListTopicSubscriptionsPagedResponse> listTopicSubscriptionsSettings()

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

listTopicSnapshotsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTopicSnapshotsRequest,ListTopicSnapshotsResponse,TopicAdminClient.ListTopicSnapshotsPagedResponse> listTopicSnapshotsSettings()

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

deleteTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTopicRequest,com.google.protobuf.Empty> deleteTopicSettings()

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

detachSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DetachSubscriptionRequest,DetachSubscriptionResponse> detachSubscriptionSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.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 com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final TopicAdminSettings create(PublisherStubSettings stub)
                                       throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static TopicAdminSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static TopicAdminSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static TopicAdminSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public TopicAdminSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<TopicAdminSettings>