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 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 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)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
subscriptionsServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(SubscriptionsServiceStubSettings stub)
public static final SubscriptionsServiceSettings create(SubscriptionsServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
SubscriptionsServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
SubscriptionsServiceSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider |
|
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static SubscriptionsServiceSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
SubscriptionsServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static SubscriptionsServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
SubscriptionsServiceSettings.Builder |
|
newHttpJsonBuilder()
public static SubscriptionsServiceSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
SubscriptionsServiceSettings.Builder |
|
Constructors
SubscriptionsServiceSettings(SubscriptionsServiceSettings.Builder settingsBuilder)
protected SubscriptionsServiceSettings(SubscriptionsServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
SubscriptionsServiceSettings.Builder |
Methods
createSubscriptionOperationSettings()
public OperationCallSettings<CreateSubscriptionRequest,Subscription,CreateSubscriptionMetadata> createSubscriptionOperationSettings()Returns the object with the settings used for calls to createSubscription.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSubscriptionRequest,Subscription,CreateSubscriptionMetadata> |
|
createSubscriptionSettings()
public UnaryCallSettings<CreateSubscriptionRequest,Operation> createSubscriptionSettings()Returns the object with the settings used for calls to createSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSubscriptionRequest,Operation> |
|
deleteSubscriptionOperationSettings()
public OperationCallSettings<DeleteSubscriptionRequest,Empty,DeleteSubscriptionMetadata> deleteSubscriptionOperationSettings()Returns the object with the settings used for calls to deleteSubscription.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSubscriptionRequest,Empty,DeleteSubscriptionMetadata> |
|
deleteSubscriptionSettings()
public UnaryCallSettings<DeleteSubscriptionRequest,Operation> deleteSubscriptionSettings()Returns the object with the settings used for calls to deleteSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSubscriptionRequest,Operation> |
|
getSubscriptionSettings()
public UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()Returns the object with the settings used for calls to getSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSubscriptionRequest,Subscription> |
|
listSubscriptionsSettings()
public PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,SubscriptionsServiceClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()Returns the object with the settings used for calls to listSubscriptions.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,ListSubscriptionsPagedResponse> |
|
reactivateSubscriptionOperationSettings()
public OperationCallSettings<ReactivateSubscriptionRequest,Subscription,ReactivateSubscriptionMetadata> reactivateSubscriptionOperationSettings()Returns the object with the settings used for calls to reactivateSubscription.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ReactivateSubscriptionRequest,Subscription,ReactivateSubscriptionMetadata> |
|
reactivateSubscriptionSettings()
public UnaryCallSettings<ReactivateSubscriptionRequest,Operation> reactivateSubscriptionSettings()Returns the object with the settings used for calls to reactivateSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ReactivateSubscriptionRequest,Operation> |
|
toBuilder()
public SubscriptionsServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
SubscriptionsServiceSettings.Builder |
|
updateSubscriptionOperationSettings()
public OperationCallSettings<UpdateSubscriptionRequest,Subscription,UpdateSubscriptionMetadata> updateSubscriptionOperationSettings()Returns the object with the settings used for calls to updateSubscription.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateSubscriptionRequest,Subscription,UpdateSubscriptionMetadata> |
|
updateSubscriptionSettings()
public UnaryCallSettings<UpdateSubscriptionRequest,Operation> updateSubscriptionSettings()Returns the object with the settings used for calls to updateSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSubscriptionRequest,Operation> |
|