@BetaApi @Generated(value="by gapic-generator-java") public class WorkstationsStubSettings extends com.google.api.gax.rpc.StubSettings<WorkstationsStubSettings>
WorkstationsStub.
The default instance has everything set to sensible defaults:
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 getWorkstationCluster:
// 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
WorkstationsStubSettings.Builder workstationsSettingsBuilder =
WorkstationsStubSettings.newBuilder();
workstationsSettingsBuilder
.getWorkstationClusterSettings()
.setRetrySettings(
workstationsSettingsBuilder
.getWorkstationClusterSettings()
.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());
WorkstationsStubSettings workstationsSettings = workstationsSettingsBuilder.build();
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 createWorkstationCluster:
// 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
WorkstationsStubSettings.Builder workstationsSettingsBuilder =
WorkstationsStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
workstationsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
WorkstationsStubSettings.Builder
Builder for WorkstationsStubSettings.
|
| Modifier | Constructor and Description |
|---|---|
protected |
WorkstationsStubSettings(WorkstationsStubSettings.Builder settingsBuilder) |
| Modifier and Type | Method and Description |
|---|---|
WorkstationsStub |
createStub() |
com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationClusterRequest,WorkstationCluster,OperationMetadata> |
createWorkstationClusterOperationSettings()
Returns the object with the settings used for calls to createWorkstationCluster.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationClusterRequest,com.google.longrunning.Operation> |
createWorkstationClusterSettings()
Returns the object with the settings used for calls to createWorkstationCluster.
|
com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationConfigRequest,WorkstationConfig,OperationMetadata> |
createWorkstationConfigOperationSettings()
Returns the object with the settings used for calls to createWorkstationConfig.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationConfigRequest,com.google.longrunning.Operation> |
createWorkstationConfigSettings()
Returns the object with the settings used for calls to createWorkstationConfig.
|
com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationRequest,Workstation,OperationMetadata> |
createWorkstationOperationSettings()
Returns the object with the settings used for calls to createWorkstation.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationRequest,com.google.longrunning.Operation> |
createWorkstationSettings()
Returns the object with the settings used for calls to createWorkstation.
|
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder |
defaultApiClientHeaderProviderBuilder() |
static com.google.api.gax.core.GoogleCredentialsProvider.Builder |
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
|
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder |
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
|
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder |
defaultGrpcApiClientHeaderProviderBuilder() |
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder |
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
|
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder |
defaultHttpJsonApiClientHeaderProviderBuilder() |
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder |
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
|
static com.google.api.gax.rpc.TransportChannelProvider |
defaultTransportChannelProvider() |
com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationClusterRequest,WorkstationCluster,OperationMetadata> |
deleteWorkstationClusterOperationSettings()
Returns the object with the settings used for calls to deleteWorkstationCluster.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationClusterRequest,com.google.longrunning.Operation> |
deleteWorkstationClusterSettings()
Returns the object with the settings used for calls to deleteWorkstationCluster.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationConfigRequest,WorkstationConfig,OperationMetadata> |
deleteWorkstationConfigOperationSettings()
Returns the object with the settings used for calls to deleteWorkstationConfig.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationConfigRequest,com.google.longrunning.Operation> |
deleteWorkstationConfigSettings()
Returns the object with the settings used for calls to deleteWorkstationConfig.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationRequest,Workstation,OperationMetadata> |
deleteWorkstationOperationSettings()
Returns the object with the settings used for calls to deleteWorkstation.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationRequest,com.google.longrunning.Operation> |
deleteWorkstationSettings()
Returns the object with the settings used for calls to deleteWorkstation.
|
com.google.api.gax.rpc.UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse> |
generateAccessTokenSettings()
Returns the object with the settings used for calls to generateAccessToken.
|
static String |
getDefaultEndpoint()
Returns the default service endpoint.
|
static String |
getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
|
static List<String> |
getDefaultServiceScopes()
Returns the default service scopes.
|
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.
|
String |
getServiceName()
Returns the default service name.
|
com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationClusterRequest,WorkstationCluster> |
getWorkstationClusterSettings()
Returns the object with the settings used for calls to getWorkstationCluster.
|
com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationConfigRequest,WorkstationConfig> |
getWorkstationConfigSettings()
Returns the object with the settings used for calls to getWorkstationConfig.
|
com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationRequest,Workstation> |
getWorkstationSettings()
Returns the object with the settings used for calls to getWorkstation.
|
com.google.api.gax.rpc.PagedCallSettings<ListUsableWorkstationConfigsRequest,ListUsableWorkstationConfigsResponse,WorkstationsClient.ListUsableWorkstationConfigsPagedResponse> |
listUsableWorkstationConfigsSettings()
Returns the object with the settings used for calls to listUsableWorkstationConfigs.
|
com.google.api.gax.rpc.PagedCallSettings<ListUsableWorkstationsRequest,ListUsableWorkstationsResponse,WorkstationsClient.ListUsableWorkstationsPagedResponse> |
listUsableWorkstationsSettings()
Returns the object with the settings used for calls to listUsableWorkstations.
|
com.google.api.gax.rpc.PagedCallSettings<ListWorkstationClustersRequest,ListWorkstationClustersResponse,WorkstationsClient.ListWorkstationClustersPagedResponse> |
listWorkstationClustersSettings()
Returns the object with the settings used for calls to listWorkstationClusters.
|
com.google.api.gax.rpc.PagedCallSettings<ListWorkstationConfigsRequest,ListWorkstationConfigsResponse,WorkstationsClient.ListWorkstationConfigsPagedResponse> |
listWorkstationConfigsSettings()
Returns the object with the settings used for calls to listWorkstationConfigs.
|
com.google.api.gax.rpc.PagedCallSettings<ListWorkstationsRequest,ListWorkstationsResponse,WorkstationsClient.ListWorkstationsPagedResponse> |
listWorkstationsSettings()
Returns the object with the settings used for calls to listWorkstations.
|
static WorkstationsStubSettings.Builder |
newBuilder()
Returns a new gRPC builder for this class.
|
static WorkstationsStubSettings.Builder |
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
|
static WorkstationsStubSettings.Builder |
newHttpJsonBuilder()
Returns a new REST builder for this class.
|
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.
|
com.google.api.gax.rpc.OperationCallSettings<StartWorkstationRequest,Workstation,OperationMetadata> |
startWorkstationOperationSettings()
Returns the object with the settings used for calls to startWorkstation.
|
com.google.api.gax.rpc.UnaryCallSettings<StartWorkstationRequest,com.google.longrunning.Operation> |
startWorkstationSettings()
Returns the object with the settings used for calls to startWorkstation.
|
com.google.api.gax.rpc.OperationCallSettings<StopWorkstationRequest,Workstation,OperationMetadata> |
stopWorkstationOperationSettings()
Returns the object with the settings used for calls to stopWorkstation.
|
com.google.api.gax.rpc.UnaryCallSettings<StopWorkstationRequest,com.google.longrunning.Operation> |
stopWorkstationSettings()
Returns the object with the settings used for calls to stopWorkstation.
|
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.
|
WorkstationsStubSettings.Builder |
toBuilder()
Returns a builder containing all the values of this settings class.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationClusterRequest,WorkstationCluster,OperationMetadata> |
updateWorkstationClusterOperationSettings()
Returns the object with the settings used for calls to updateWorkstationCluster.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationClusterRequest,com.google.longrunning.Operation> |
updateWorkstationClusterSettings()
Returns the object with the settings used for calls to updateWorkstationCluster.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationConfigRequest,WorkstationConfig,OperationMetadata> |
updateWorkstationConfigOperationSettings()
Returns the object with the settings used for calls to updateWorkstationConfig.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationConfigRequest,com.google.longrunning.Operation> |
updateWorkstationConfigSettings()
Returns the object with the settings used for calls to updateWorkstationConfig.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationRequest,Workstation,OperationMetadata> |
updateWorkstationOperationSettings()
Returns the object with the settings used for calls to updateWorkstation.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationRequest,com.google.longrunning.Operation> |
updateWorkstationSettings()
Returns the object with the settings used for calls to updateWorkstation.
|
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toStringprotected WorkstationsStubSettings(WorkstationsStubSettings.Builder settingsBuilder) throws IOException
IOExceptionpublic com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationClusterRequest,WorkstationCluster> getWorkstationClusterSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListWorkstationClustersRequest,ListWorkstationClustersResponse,WorkstationsClient.ListWorkstationClustersPagedResponse> listWorkstationClustersSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationClusterRequest,com.google.longrunning.Operation> createWorkstationClusterSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationClusterRequest,WorkstationCluster,OperationMetadata> createWorkstationClusterOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationClusterRequest,com.google.longrunning.Operation> updateWorkstationClusterSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationClusterRequest,WorkstationCluster,OperationMetadata> updateWorkstationClusterOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationClusterRequest,com.google.longrunning.Operation> deleteWorkstationClusterSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationClusterRequest,WorkstationCluster,OperationMetadata> deleteWorkstationClusterOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationConfigRequest,WorkstationConfig> getWorkstationConfigSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListWorkstationConfigsRequest,ListWorkstationConfigsResponse,WorkstationsClient.ListWorkstationConfigsPagedResponse> listWorkstationConfigsSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListUsableWorkstationConfigsRequest,ListUsableWorkstationConfigsResponse,WorkstationsClient.ListUsableWorkstationConfigsPagedResponse> listUsableWorkstationConfigsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationConfigRequest,com.google.longrunning.Operation> createWorkstationConfigSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationConfigRequest,WorkstationConfig,OperationMetadata> createWorkstationConfigOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationConfigRequest,com.google.longrunning.Operation> updateWorkstationConfigSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationConfigRequest,WorkstationConfig,OperationMetadata> updateWorkstationConfigOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationConfigRequest,com.google.longrunning.Operation> deleteWorkstationConfigSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationConfigRequest,WorkstationConfig,OperationMetadata> deleteWorkstationConfigOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationRequest,Workstation> getWorkstationSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListWorkstationsRequest,ListWorkstationsResponse,WorkstationsClient.ListWorkstationsPagedResponse> listWorkstationsSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListUsableWorkstationsRequest,ListUsableWorkstationsResponse,WorkstationsClient.ListUsableWorkstationsPagedResponse> listUsableWorkstationsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationRequest,com.google.longrunning.Operation> createWorkstationSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationRequest,Workstation,OperationMetadata> createWorkstationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationRequest,com.google.longrunning.Operation> updateWorkstationSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationRequest,Workstation,OperationMetadata> updateWorkstationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationRequest,com.google.longrunning.Operation> deleteWorkstationSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationRequest,Workstation,OperationMetadata> deleteWorkstationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<StartWorkstationRequest,com.google.longrunning.Operation> startWorkstationSettings()
public com.google.api.gax.rpc.OperationCallSettings<StartWorkstationRequest,Workstation,OperationMetadata> startWorkstationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<StopWorkstationRequest,com.google.longrunning.Operation> stopWorkstationSettings()
public com.google.api.gax.rpc.OperationCallSettings<StopWorkstationRequest,Workstation,OperationMetadata> stopWorkstationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse> generateAccessTokenSettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
public WorkstationsStub createStub() throws IOException
IOExceptionpublic String getServiceName()
getServiceName in class com.google.api.gax.rpc.StubSettings<WorkstationsStubSettings>public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
@ObsoleteApi(value="Use getEndpoint() instead") public static String getDefaultEndpoint()
public static String getDefaultMtlsEndpoint()
public static List<String> getDefaultServiceScopes()
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
public static WorkstationsStubSettings.Builder newBuilder()
public static WorkstationsStubSettings.Builder newHttpJsonBuilder()
public static WorkstationsStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
public WorkstationsStubSettings.Builder toBuilder()
toBuilder in class com.google.api.gax.rpc.StubSettings<WorkstationsStubSettings>Copyright © 2025 Google LLC. All rights reserved.