Class WorkflowsSettings (2.3.2)

Version 2.3.2

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.6
• 2.2.1
• 2.1.10

public class WorkflowsSettings extends ClientSettings<WorkflowsSettings>

Settings class to configure an instance of WorkflowsClient.

The default instance has everything set to sensible defaults:

• The default service address (workflows.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 getWorkflow to 30 seconds:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 WorkflowsSettings.Builder workflowsSettingsBuilder = WorkflowsSettings.newBuilder();
 workflowsSettingsBuilder
     .getWorkflowSettings()
     .setRetrySettings(
         workflowsSettingsBuilder
             .getWorkflowSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WorkflowsSettings workflowsSettings = workflowsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > WorkflowsSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(WorkflowsStubSettings stub)

public static final WorkflowsSettings create(WorkflowsStubSettings stub)

Parameter

Name	Description
stub	WorkflowsStubSettings

Returns

Type	Description
WorkflowsSettings

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 WorkflowsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
WorkflowsSettings.Builder

newBuilder(ClientContext clientContext)

public static WorkflowsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
WorkflowsSettings.Builder

newHttpJsonBuilder()

public static WorkflowsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
WorkflowsSettings.Builder

Constructors

WorkflowsSettings(WorkflowsSettings.Builder settingsBuilder)

protected WorkflowsSettings(WorkflowsSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	WorkflowsSettings.Builder

Methods

createWorkflowOperationSettings()

public OperationCallSettings<CreateWorkflowRequest,Workflow,OperationMetadata> createWorkflowOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateWorkflowRequest,Workflow,OperationMetadata>

createWorkflowSettings()

public UnaryCallSettings<CreateWorkflowRequest,Operation> createWorkflowSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateWorkflowRequest,Operation>

deleteWorkflowOperationSettings()

public OperationCallSettings<DeleteWorkflowRequest,Empty,OperationMetadata> deleteWorkflowOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteWorkflowRequest,Empty,OperationMetadata>

deleteWorkflowSettings()

public UnaryCallSettings<DeleteWorkflowRequest,Operation> deleteWorkflowSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteWorkflowRequest,Operation>

getWorkflowSettings()

public UnaryCallSettings<GetWorkflowRequest,Workflow> getWorkflowSettings()

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

Returns

Type	Description
UnaryCallSettings<GetWorkflowRequest,Workflow>

listWorkflowsSettings()

public PagedCallSettings<ListWorkflowsRequest,ListWorkflowsResponse,WorkflowsClient.ListWorkflowsPagedResponse> listWorkflowsSettings()

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

Returns

Type	Description
PagedCallSettings<ListWorkflowsRequest,ListWorkflowsResponse,ListWorkflowsPagedResponse>

toBuilder()

public WorkflowsSettings.Builder toBuilder()

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

Returns

Type	Description
WorkflowsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateWorkflowOperationSettings()

public OperationCallSettings<UpdateWorkflowRequest,Workflow,OperationMetadata> updateWorkflowOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdateWorkflowRequest,Workflow,OperationMetadata>

updateWorkflowSettings()

public UnaryCallSettings<UpdateWorkflowRequest,Operation> updateWorkflowSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateWorkflowRequest,Operation>