Package 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("by gapic-generator-java")
public class PublisherStubSettings
extends com.google.api.gax.rpc.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:
// 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
PublisherStubSettings.Builder topicAdminSettingsBuilder = PublisherStubSettings.newBuilder();
topicAdminSettingsBuilder
.createTopicSettings()
.setRetrySettings(
topicAdminSettingsBuilder
.createTopicSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
PublisherStubSettings topicAdminSettings = topicAdminSettingsBuilder.build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder for PublisherStubSettings. -
Constructor Summary
ModifierConstructorDescriptionprotected
PublisherStubSettings
(PublisherStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createTopic.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
com.google.api.gax.rpc.UnaryCallSettings<DeleteTopicRequest,
com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteTopic.com.google.api.gax.rpc.UnaryCallSettings<DetachSubscriptionRequest,
DetachSubscriptionResponse> Returns the object with the settings used for calls to detachSubscription.static String
Returns the default service endpoint.static String
Returns the default mTLS service endpoint.Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,
com.google.iam.v1.Policy> Returns the object with the settings used for calls to getIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<GetTopicRequest,
Topic> Returns the object with the settings used for calls to getTopic.com.google.api.gax.rpc.PagedCallSettings<ListTopicSnapshotsRequest,
ListTopicSnapshotsResponse, TopicAdminClient.ListTopicSnapshotsPagedResponse> Returns the object with the settings used for calls to listTopicSnapshots.com.google.api.gax.rpc.PagedCallSettings<ListTopicsRequest,
ListTopicsResponse, TopicAdminClient.ListTopicsPagedResponse> Returns the object with the settings used for calls to listTopics.com.google.api.gax.rpc.PagedCallSettings<ListTopicSubscriptionsRequest,
ListTopicSubscriptionsResponse, TopicAdminClient.ListTopicSubscriptionsPagedResponse> Returns the object with the settings used for calls to listTopicSubscriptions.Returns a new gRPC builder for this class.newBuilder
(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.com.google.api.gax.rpc.BatchingCallSettings<PublishRequest,
PublishResponse> 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> 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> Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdateTopicRequest,
Topic> Returns the object with the settings used for calls to updateTopic.Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
Constructor Details
-
PublisherStubSettings
- Throws:
IOException
-
-
Method Details
-
createTopicSettings
Returns the object with the settings used for calls to createTopic. -
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
Returns the object with the settings used for calls to getTopic. -
listTopicsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListTopicsRequest,ListTopicsResponse, listTopicsSettings()TopicAdminClient.ListTopicsPagedResponse> Returns the object with the settings used for calls to listTopics. -
listTopicSubscriptionsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse, listTopicSubscriptionsSettings()TopicAdminClient.ListTopicSubscriptionsPagedResponse> Returns the object with the settings used for calls to listTopicSubscriptions. -
listTopicSnapshotsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListTopicSnapshotsRequest,ListTopicSnapshotsResponse, listTopicSnapshotsSettings()TopicAdminClient.ListTopicSnapshotsPagedResponse> 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. -
createStub
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
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() -
defaultGrpcApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() -
defaultHttpJsonApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() -
defaultApiClientHeaderProviderBuilder
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() -
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
public static PublisherStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.StubSettings<PublisherStubSettings>
-