Class ExecutionsStubSettings (0.72.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 0.78.0 (latest)
- 0.76.0
- 0.75.0
- 0.74.0
- 0.73.0
- 0.72.0
- 0.70.0
- 0.68.0
- 0.67.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.5
- 0.2.1
- 0.1.2
publicclass ExecutionsStubSettingsextendsStubSettings<ExecutionsStubSettings>Settings class to configure an instance of ExecutionsStub.
The default instance has everything set to sensible defaults:
- The default service address (run.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 getExecution:
// 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
ExecutionsStubSettings.BuilderexecutionsSettingsBuilder=ExecutionsStubSettings.newBuilder();
executionsSettingsBuilder
.getExecutionSettings()
.setRetrySettings(
executionsSettingsBuilder
.getExecutionSettings()
.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());
ExecutionsStubSettingsexecutionsSettings=executionsSettingsBuilder.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 deleteExecution:
// 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
ExecutionsStubSettings.BuilderexecutionsSettingsBuilder=ExecutionsStubSettings.newBuilder();
TimedRetryAlgorithmtimedRetryAlgorithm=
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
executionsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Inherited Members
Static Methods
defaultApiClientHeaderProviderBuilder()
publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultCredentialsProviderBuilder()
publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultExecutorProviderBuilder()
publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultGrpcApiClientHeaderProviderBuilder()
publicstaticApiClientHeaderProvider.BuilderdefaultGrpcApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultGrpcTransportProviderBuilder()
publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonApiClientHeaderProviderBuilder()
publicstaticApiClientHeaderProvider.BuilderdefaultHttpJsonApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultTransportChannelProvider()
publicstaticTransportChannelProviderdefaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider |
|
getDefaultEndpoint()
publicstaticStringgetDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultMtlsEndpoint()
publicstaticStringgetDefaultMtlsEndpoint()Returns the default mTLS service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultServiceScopes()
publicstaticList<String>getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
publicstaticExecutionsStubSettings.BuildernewBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
ExecutionsStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
publicstaticExecutionsStubSettings.BuildernewBuilder(ClientContextclientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
ExecutionsStubSettings.Builder |
|
newHttpJsonBuilder()
publicstaticExecutionsStubSettings.BuildernewHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
ExecutionsStubSettings.Builder |
|
Constructors
ExecutionsStubSettings(ExecutionsStubSettings.Builder settingsBuilder)
protectedExecutionsStubSettings(ExecutionsStubSettings.BuildersettingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
ExecutionsStubSettings.Builder |
Methods
cancelExecutionOperationSettings()
publicOperationCallSettings<CancelExecutionRequest,Execution,Execution>cancelExecutionOperationSettings()Returns the object with the settings used for calls to cancelExecution.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CancelExecutionRequest,Execution,Execution> |
|
cancelExecutionSettings()
publicUnaryCallSettings<CancelExecutionRequest,Operation>cancelExecutionSettings()Returns the object with the settings used for calls to cancelExecution.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CancelExecutionRequest,Operation> |
|
createStub()
publicExecutionsStubcreateStub()| Returns | |
|---|---|
| Type | Description |
ExecutionsStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteExecutionOperationSettings()
publicOperationCallSettings<DeleteExecutionRequest,Execution,Execution>deleteExecutionOperationSettings()Returns the object with the settings used for calls to deleteExecution.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteExecutionRequest,Execution,Execution> |
|
deleteExecutionSettings()
publicUnaryCallSettings<DeleteExecutionRequest,Operation>deleteExecutionSettings()Returns the object with the settings used for calls to deleteExecution.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteExecutionRequest,Operation> |
|
getExecutionSettings()
publicUnaryCallSettings<GetExecutionRequest,Execution>getExecutionSettings()Returns the object with the settings used for calls to getExecution.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetExecutionRequest,Execution> |
|
getServiceName()
publicStringgetServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
listExecutionsSettings()
publicPagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,ExecutionsClient.ListExecutionsPagedResponse>listExecutionsSettings()Returns the object with the settings used for calls to listExecutions.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,ListExecutionsPagedResponse> |
|
toBuilder()
publicExecutionsStubSettings.BuildertoBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
ExecutionsStubSettings.Builder |
|