Package com.google.cloud.workflows.executions.v1 (2.3.6)

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.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.newBuilder()
         .setTransportChannelProvider(
             ExecutionsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.