- 2.51.0 (latest)
- 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.7
A client to Workflow Executions API
The interfaces provided are listed below, along with usage samples.
ExecutionsClient
Service Description: Executions is used to start and manage running instances of Workflows called executions.
Sample for ExecutionsClient:
// 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
try (ExecutionsClient executionsClient = ExecutionsClient.create()) {
WorkflowName parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
Execution execution = Execution.newBuilder().build();
Execution response = executionsClient.createExecution(parent, execution);
}
Classes
CancelExecutionRequest
Request for the CancelExecution method.
Protobuf type google.cloud.workflows.executions.v1.CancelExecutionRequest
CancelExecutionRequest.Builder
Request for the CancelExecution method.
Protobuf type google.cloud.workflows.executions.v1.CancelExecutionRequest
CreateExecutionRequest
Request for the CreateExecution method.
Protobuf type google.cloud.workflows.executions.v1.CreateExecutionRequest
CreateExecutionRequest.Builder
Request for the CreateExecution method.
Protobuf type google.cloud.workflows.executions.v1.CreateExecutionRequest
Execution
A running instance of a Workflow.
Protobuf type google.cloud.workflows.executions.v1.Execution
Execution.Builder
A running instance of a Workflow.
Protobuf type google.cloud.workflows.executions.v1.Execution
Execution.Error
Error describes why the execution was abnormally terminated.
Protobuf type google.cloud.workflows.executions.v1.Execution.Error
Execution.Error.Builder
Error describes why the execution was abnormally terminated.
Protobuf type google.cloud.workflows.executions.v1.Execution.Error
Execution.StackTrace
A collection of stack elements (frames) where an error occurred.
Protobuf type google.cloud.workflows.executions.v1.Execution.StackTrace
Execution.StackTrace.Builder
A collection of stack elements (frames) where an error occurred.
Protobuf type google.cloud.workflows.executions.v1.Execution.StackTrace
Execution.StackTraceElement
A single stack element (frame) where an error occurred.
Protobuf type google.cloud.workflows.executions.v1.Execution.StackTraceElement
Execution.StackTraceElement.Builder
A single stack element (frame) where an error occurred.
Protobuf type google.cloud.workflows.executions.v1.Execution.StackTraceElement
Execution.StackTraceElement.Position
Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes.
Protobuf type
google.cloud.workflows.executions.v1.Execution.StackTraceElement.Position
Execution.StackTraceElement.Position.Builder
Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes.
Protobuf type
google.cloud.workflows.executions.v1.Execution.StackTraceElement.Position
ExecutionName
ExecutionName.Builder
Builder for projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.
ExecutionsClient
Service Description: Executions is used to start and manage running instances of Workflows called executions.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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
try (ExecutionsClient executionsClient = ExecutionsClient.create()) {
WorkflowName parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
Execution execution = Execution.newBuilder().build();
Execution response = executionsClient.createExecution(parent, execution);
}
Note: close() needs to be called on the ExecutionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ExecutionsSettings to create(). For example:
To customize credentials:
// 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
ExecutionsSettings executionsSettings =
ExecutionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);
To customize the endpoint:
// 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
ExecutionsSettings executionsSettings =
ExecutionsSettings.newBuilder().setEndpoint(myEndpoint).build();
ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ExecutionsSettings executionsSettings = ExecutionsSettings.newHttpJsonBuilder().build();
ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ExecutionsClient.ListExecutionsFixedSizeCollection
ExecutionsClient.ListExecutionsPage
ExecutionsClient.ListExecutionsPagedResponse
ExecutionsGrpc
Executions is used to start and manage running instances of Workflows called executions.
ExecutionsGrpc.ExecutionsBlockingStub
Executions is used to start and manage running instances of Workflows called executions.
ExecutionsGrpc.ExecutionsFutureStub
Executions is used to start and manage running instances of Workflows called executions.
ExecutionsGrpc.ExecutionsImplBase
Executions is used to start and manage running instances of Workflows called executions.
ExecutionsGrpc.ExecutionsStub
Executions is used to start and manage running instances of Workflows called executions.
ExecutionsProto
ExecutionsSettings
Settings class to configure an instance of ExecutionsClient.
The default instance has everything set to sensible defaults:
- The default service address (workflowexecutions.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 createExecution 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
ExecutionsSettings.Builder executionsSettingsBuilder = ExecutionsSettings.newBuilder();
executionsSettingsBuilder
.createExecutionSettings()
.setRetrySettings(
executionsSettingsBuilder.createExecutionSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ExecutionsSettings executionsSettings = executionsSettingsBuilder.build();
ExecutionsSettings.Builder
Builder for ExecutionsSettings.
GetExecutionRequest
Request for the GetExecution method.
Protobuf type google.cloud.workflows.executions.v1.GetExecutionRequest
GetExecutionRequest.Builder
Request for the GetExecution method.
Protobuf type google.cloud.workflows.executions.v1.GetExecutionRequest
ListExecutionsRequest
Request for the [ListExecutions][] method.
Protobuf type google.cloud.workflows.executions.v1.ListExecutionsRequest
ListExecutionsRequest.Builder
Request for the [ListExecutions][] method.
Protobuf type google.cloud.workflows.executions.v1.ListExecutionsRequest
ListExecutionsResponse
Response for the ListExecutions method.
Protobuf type google.cloud.workflows.executions.v1.ListExecutionsResponse
ListExecutionsResponse.Builder
Response for the ListExecutions method.
Protobuf type google.cloud.workflows.executions.v1.ListExecutionsResponse
WorkflowName
WorkflowName.Builder
Builder for projects/{project}/locations/{location}/workflows/{workflow}.
Interfaces
CancelExecutionRequestOrBuilder
CreateExecutionRequestOrBuilder
Execution.ErrorOrBuilder
Execution.StackTraceElement.PositionOrBuilder
Execution.StackTraceElementOrBuilder
Execution.StackTraceOrBuilder
ExecutionOrBuilder
GetExecutionRequestOrBuilder
ListExecutionsRequestOrBuilder
ListExecutionsResponseOrBuilder
Enums
Execution.CallLogLevel
Describes the level of platform logging to apply to calls and call responses during workflow executions.
Protobuf enum google.cloud.workflows.executions.v1.Execution.CallLogLevel
Execution.State
Describes the current state of the execution. More states might be added in the future.
Protobuf enum google.cloud.workflows.executions.v1.Execution.State
ExecutionView
Defines possible views for execution resource.
Protobuf enum google.cloud.workflows.executions.v1.ExecutionView