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