Package com.google.cloud.pubsub.v1
Class SubscriptionAdminSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<SubscriptionAdminSettings>
com.google.cloud.pubsub.v1.SubscriptionAdminSettings
@Generated("by gapic-generator-java")
public class SubscriptionAdminSettings
extends com.google.api.gax.rpc.ClientSettings<SubscriptionAdminSettings>
Settings class to configure an instance of
SubscriptionAdminClient
.
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 createSubscription 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
SubscriptionAdminSettings.Builder subscriptionAdminSettingsBuilder =
SubscriptionAdminSettings.newBuilder();
subscriptionAdminSettingsBuilder
.createSubscriptionSettings()
.setRetrySettings(
subscriptionAdminSettingsBuilder
.createSubscriptionSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
SubscriptionAdminSettings subscriptionAdminSettings = subscriptionAdminSettingsBuilder.build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder for SubscriptionAdminSettings. -
Constructor Summary
ModifierConstructorDescriptionprotected
SubscriptionAdminSettings
(SubscriptionAdminSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptioncom.google.api.gax.rpc.UnaryCallSettings<AcknowledgeRequest,
com.google.protobuf.Empty> Returns the object with the settings used for calls to acknowledge.static final SubscriptionAdminSettings
create
(SubscriberStubSettings stub) com.google.api.gax.rpc.UnaryCallSettings<CreateSnapshotRequest,
Snapshot> Returns the object with the settings used for calls to createSnapshot.com.google.api.gax.rpc.UnaryCallSettings<Subscription,
Subscription> Returns the object with the settings used for calls to createSubscription.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.grpc.InstantiatingGrpcChannelProvider.Builder
Returns a builder for the default gRPC ChannelProvider for this service.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<DeleteSnapshotRequest,
com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteSnapshot.com.google.api.gax.rpc.UnaryCallSettings<DeleteSubscriptionRequest,
com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteSubscription.static String
Returns the default 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<GetSnapshotRequest,
Snapshot> Returns the object with the settings used for calls to getSnapshot.com.google.api.gax.rpc.UnaryCallSettings<GetSubscriptionRequest,
Subscription> Returns the object with the settings used for calls to getSubscription.com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,
ListSnapshotsResponse, SubscriptionAdminClient.ListSnapshotsPagedResponse> Returns the object with the settings used for calls to listSnapshots.com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,
ListSubscriptionsResponse, SubscriptionAdminClient.ListSubscriptionsPagedResponse> Returns the object with the settings used for calls to listSubscriptions.com.google.api.gax.rpc.UnaryCallSettings<ModifyAckDeadlineRequest,
com.google.protobuf.Empty> Returns the object with the settings used for calls to modifyAckDeadline.com.google.api.gax.rpc.UnaryCallSettings<ModifyPushConfigRequest,
com.google.protobuf.Empty> Returns the object with the settings used for calls to modifyPushConfig.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.UnaryCallSettings<PullRequest,
PullResponse> Returns the object with the settings used for calls to pull.com.google.api.gax.rpc.UnaryCallSettings<SeekRequest,
SeekResponse> Returns the object with the settings used for calls to seek.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.StreamingCallSettings<StreamingPullRequest,
StreamingPullResponse> Returns the object with the settings used for calls to streamingPull.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<UpdateSnapshotRequest,
Snapshot> Returns the object with the settings used for calls to updateSnapshot.com.google.api.gax.rpc.UnaryCallSettings<UpdateSubscriptionRequest,
Subscription> Returns the object with the settings used for calls to updateSubscription.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
Constructor Details
-
SubscriptionAdminSettings
protected SubscriptionAdminSettings(SubscriptionAdminSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createSubscriptionSettings
public com.google.api.gax.rpc.UnaryCallSettings<Subscription,Subscription> createSubscriptionSettings()Returns the object with the settings used for calls to createSubscription. -
getSubscriptionSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()Returns the object with the settings used for calls to getSubscription. -
updateSubscriptionSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateSubscriptionRequest,Subscription> updateSubscriptionSettings()Returns the object with the settings used for calls to updateSubscription. -
listSubscriptionsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse, listSubscriptionsSettings()SubscriptionAdminClient.ListSubscriptionsPagedResponse> Returns the object with the settings used for calls to listSubscriptions. -
deleteSubscriptionSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty> deleteSubscriptionSettings()Returns the object with the settings used for calls to deleteSubscription. -
modifyAckDeadlineSettings
public com.google.api.gax.rpc.UnaryCallSettings<ModifyAckDeadlineRequest,com.google.protobuf.Empty> modifyAckDeadlineSettings()Returns the object with the settings used for calls to modifyAckDeadline. -
acknowledgeSettings
public com.google.api.gax.rpc.UnaryCallSettings<AcknowledgeRequest,com.google.protobuf.Empty> acknowledgeSettings()Returns the object with the settings used for calls to acknowledge. -
pullSettings
Returns the object with the settings used for calls to pull. -
streamingPullSettings
public com.google.api.gax.rpc.StreamingCallSettings<StreamingPullRequest,StreamingPullResponse> streamingPullSettings()Returns the object with the settings used for calls to streamingPull. -
modifyPushConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<ModifyPushConfigRequest,com.google.protobuf.Empty> modifyPushConfigSettings()Returns the object with the settings used for calls to modifyPushConfig. -
getSnapshotSettings
Returns the object with the settings used for calls to getSnapshot. -
listSnapshotsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse, listSnapshotsSettings()SubscriptionAdminClient.ListSnapshotsPagedResponse> Returns the object with the settings used for calls to listSnapshots. -
createSnapshotSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateSnapshotRequest,Snapshot> createSnapshotSettings()Returns the object with the settings used for calls to createSnapshot. -
updateSnapshotSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateSnapshotRequest,Snapshot> updateSnapshotSettings()Returns the object with the settings used for calls to updateSnapshot. -
deleteSnapshotSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteSnapshotRequest,com.google.protobuf.Empty> deleteSnapshotSettings()Returns the object with the settings used for calls to deleteSnapshot. -
seekSettings
Returns the object with the settings used for calls to seek. -
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 SubscriptionAdminSettings create(SubscriberStubSettings 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
Returns the default 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() -
defaultApiClientHeaderProviderBuilder
@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 defaultApiClientHeaderProviderBuilder() -
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
public static SubscriptionAdminSettings.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.ClientSettings<SubscriptionAdminSettings>
-