Class WorkflowsServiceV2BetaSettings (0.56.0) 

public class WorkflowsServiceV2BetaSettings extends ClientSettings<WorkflowsServiceV2BetaSettings>

Settings class to configure an instance of WorkflowsServiceV2BetaClient.

The default instance has everything set to sensible defaults:

  • The default service address (lifesciences.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 getLocation:


 // 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
 WorkflowsServiceV2BetaSettings.Builder workflowsServiceV2BetaSettingsBuilder =
     WorkflowsServiceV2BetaSettings.newBuilder();
 workflowsServiceV2BetaSettingsBuilder
     .getLocationSettings()
     .setRetrySettings(
         workflowsServiceV2BetaSettingsBuilder
             .getLocationSettings()
             .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());
 WorkflowsServiceV2BetaSettings workflowsServiceV2BetaSettings =
     workflowsServiceV2BetaSettingsBuilder.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 runPipeline:


 // 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
 WorkflowsServiceV2BetaSettings.Builder workflowsServiceV2BetaSettingsBuilder =
     WorkflowsServiceV2BetaSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 workflowsServiceV2BetaSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > WorkflowsServiceV2BetaSettings

Static Methods

create(WorkflowsServiceV2BetaStubSettings stub)

public static final WorkflowsServiceV2BetaSettings create(WorkflowsServiceV2BetaStubSettings stub)
Parameter
Name Description
stub WorkflowsServiceV2BetaStubSettings
Returns
Type Description
WorkflowsServiceV2BetaSettings
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 WorkflowsServiceV2BetaSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
WorkflowsServiceV2BetaSettings.Builder

newBuilder(ClientContext clientContext)

public static WorkflowsServiceV2BetaSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
WorkflowsServiceV2BetaSettings.Builder

newHttpJsonBuilder()

public static WorkflowsServiceV2BetaSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
WorkflowsServiceV2BetaSettings.Builder

Constructors

WorkflowsServiceV2BetaSettings(WorkflowsServiceV2BetaSettings.Builder settingsBuilder)

protected WorkflowsServiceV2BetaSettings(WorkflowsServiceV2BetaSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder WorkflowsServiceV2BetaSettings.Builder

Methods

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,WorkflowsServiceV2BetaClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

runPipelineOperationSettings()

public OperationCallSettings<RunPipelineRequest,RunPipelineResponse,Metadata> runPipelineOperationSettings()

Returns the object with the settings used for calls to runPipeline.

Returns
Type Description
OperationCallSettings<RunPipelineRequest,RunPipelineResponse,Metadata>

runPipelineSettings()

public UnaryCallSettings<RunPipelineRequest,Operation> runPipelineSettings()

Returns the object with the settings used for calls to runPipeline.

Returns
Type Description
UnaryCallSettings<RunPipelineRequest,Operation>

toBuilder()

public WorkflowsServiceV2BetaSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
WorkflowsServiceV2BetaSettings.Builder
Overrides