Class SubscriptionsServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<SubscriptionsServiceSettings>
com.google.apps.events.subscriptions.v1.SubscriptionsServiceSettings
@Generated("by gapic-generator-java")
public class SubscriptionsServiceSettings
extends ClientSettings<SubscriptionsServiceSettings>
Settings class to configure an instance of
SubscriptionsServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (workspaceevents.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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getSubscription:
// 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
SubscriptionsServiceSettings.Builder subscriptionsServiceSettingsBuilder =
SubscriptionsServiceSettings.newBuilder();
subscriptionsServiceSettingsBuilder
.getSubscriptionSettings()
.setRetrySettings(
subscriptionsServiceSettingsBuilder
.getSubscriptionSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
SubscriptionsServiceSettings subscriptionsServiceSettings =
subscriptionsServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createSubscription:
// 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
SubscriptionsServiceSettings.Builder subscriptionsServiceSettingsBuilder =
SubscriptionsServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
subscriptionsServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for SubscriptionsServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSubscriptionsServiceSettings(SubscriptionsServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final SubscriptionsServiceSettingsReturns the object with the settings used for calls to createSubscription.Returns the object with the settings used for calls to createSubscription.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty, DeleteSubscriptionMetadata> Returns the object with the settings used for calls to deleteSubscription.Returns the object with the settings used for calls to deleteSubscription.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getSubscription.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse, SubscriptionsServiceClient.ListSubscriptionsPagedResponse> Returns the object with the settings used for calls to listSubscriptions.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to reactivateSubscription.Returns the object with the settings used for calls to reactivateSubscription.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateSubscription.Returns the object with the settings used for calls to updateSubscription.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
SubscriptionsServiceSettings
protected SubscriptionsServiceSettings(SubscriptionsServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createSubscriptionSettings
Returns the object with the settings used for calls to createSubscription. -
createSubscriptionOperationSettings
public OperationCallSettings<CreateSubscriptionRequest,Subscription, createSubscriptionOperationSettings()CreateSubscriptionMetadata> Returns the object with the settings used for calls to createSubscription. -
deleteSubscriptionSettings
Returns the object with the settings used for calls to deleteSubscription. -
deleteSubscriptionOperationSettings
public OperationCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty, deleteSubscriptionOperationSettings()DeleteSubscriptionMetadata> Returns the object with the settings used for calls to deleteSubscription. -
getSubscriptionSettings
Returns the object with the settings used for calls to getSubscription. -
listSubscriptionsSettings
public PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse, listSubscriptionsSettings()SubscriptionsServiceClient.ListSubscriptionsPagedResponse> Returns the object with the settings used for calls to listSubscriptions. -
updateSubscriptionSettings
Returns the object with the settings used for calls to updateSubscription. -
updateSubscriptionOperationSettings
public OperationCallSettings<UpdateSubscriptionRequest,Subscription, updateSubscriptionOperationSettings()UpdateSubscriptionMetadata> Returns the object with the settings used for calls to updateSubscription. -
reactivateSubscriptionSettings
Returns the object with the settings used for calls to reactivateSubscription. -
reactivateSubscriptionOperationSettings
public OperationCallSettings<ReactivateSubscriptionRequest,Subscription, reactivateSubscriptionOperationSettings()ReactivateSubscriptionMetadata> Returns the object with the settings used for calls to reactivateSubscription. -
create
public static final SubscriptionsServiceSettings create(SubscriptionsServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<SubscriptionsServiceSettings>
-