Package com.google.cloud.workstations.v1

Class WorkstationsSettings

  • @Generated("by gapic-generator-java")
public class WorkstationsSettings
extends com.google.api.gax.rpc.ClientSettings<WorkstationsSettings>
    Settings class to configure an instance of WorkstationsClient.

    The default instance has everything set to sensible defaults:

    • The default service address (workstations.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 getWorkstationCluster 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
 WorkstationsSettings.Builder workstationsSettingsBuilder = WorkstationsSettings.newBuilder();
 workstationsSettingsBuilder
     .getWorkstationClusterSettings()
     .setRetrySettings(
         workstationsSettingsBuilder
             .getWorkstationClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WorkstationsSettings workstationsSettings = workstationsSettingsBuilder.build();

    • Method Detail

      • getWorkstationClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationClusterRequest,​WorkstationCluster> getWorkstationClusterSettings()
        Returns the object with the settings used for calls to getWorkstationCluster.

      • createWorkstationClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationClusterRequest,​com.google.longrunning.Operation> createWorkstationClusterSettings()
        Returns the object with the settings used for calls to createWorkstationCluster.

      • updateWorkstationClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationClusterRequest,​com.google.longrunning.Operation> updateWorkstationClusterSettings()
        Returns the object with the settings used for calls to updateWorkstationCluster.

      • deleteWorkstationClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationClusterRequest,​com.google.longrunning.Operation> deleteWorkstationClusterSettings()
        Returns the object with the settings used for calls to deleteWorkstationCluster.

      • getWorkstationConfigSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationConfigRequest,​WorkstationConfig> getWorkstationConfigSettings()
        Returns the object with the settings used for calls to getWorkstationConfig.

      • createWorkstationConfigSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationConfigRequest,​com.google.longrunning.Operation> createWorkstationConfigSettings()
        Returns the object with the settings used for calls to createWorkstationConfig.

      • updateWorkstationConfigSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationConfigRequest,​com.google.longrunning.Operation> updateWorkstationConfigSettings()
        Returns the object with the settings used for calls to updateWorkstationConfig.

      • deleteWorkstationConfigSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationConfigRequest,​com.google.longrunning.Operation> deleteWorkstationConfigSettings()
        Returns the object with the settings used for calls to deleteWorkstationConfig.

      • getWorkstationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetWorkstationRequest,​Workstation> getWorkstationSettings()
        Returns the object with the settings used for calls to getWorkstation.

      • createWorkstationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateWorkstationRequest,​com.google.longrunning.Operation> createWorkstationSettings()
        Returns the object with the settings used for calls to createWorkstation.

      • createWorkstationOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateWorkstationRequest,​Workstation,​OperationMetadata> createWorkstationOperationSettings()
        Returns the object with the settings used for calls to createWorkstation.

      • updateWorkstationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateWorkstationRequest,​com.google.longrunning.Operation> updateWorkstationSettings()
        Returns the object with the settings used for calls to updateWorkstation.

      • updateWorkstationOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpdateWorkstationRequest,​Workstation,​OperationMetadata> updateWorkstationOperationSettings()
        Returns the object with the settings used for calls to updateWorkstation.

      • deleteWorkstationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteWorkstationRequest,​com.google.longrunning.Operation> deleteWorkstationSettings()
        Returns the object with the settings used for calls to deleteWorkstation.

      • deleteWorkstationOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteWorkstationRequest,​Workstation,​OperationMetadata> deleteWorkstationOperationSettings()
        Returns the object with the settings used for calls to deleteWorkstation.

      • startWorkstationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<StartWorkstationRequest,​com.google.longrunning.Operation> startWorkstationSettings()
        Returns the object with the settings used for calls to startWorkstation.

      • startWorkstationOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<StartWorkstationRequest,​Workstation,​OperationMetadata> startWorkstationOperationSettings()
        Returns the object with the settings used for calls to startWorkstation.

      • stopWorkstationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<StopWorkstationRequest,​com.google.longrunning.Operation> stopWorkstationSettings()
        Returns the object with the settings used for calls to stopWorkstation.

      • stopWorkstationOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<StopWorkstationRequest,​Workstation,​OperationMetadata> stopWorkstationOperationSettings()
        Returns the object with the settings used for calls to stopWorkstation.

      • 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.

      • defaultExecutorProviderBuilder

        public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
        Returns a builder for the default ExecutorProvider for this service.

      • getDefaultEndpoint

        public static String getDefaultEndpoint()
        Returns the default service endpoint.

      • getDefaultServiceScopes

        public static List<String> 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

        public static WorkstationsSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.