Class ExecutionsClient (2.24.0)

public class ExecutionsClient implements BackgroundResource

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.

Inheritance

java.lang.Object > ExecutionsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ExecutionsClient create()

Constructs an instance of ExecutionsClient with default settings.

Returns
Type	Description
`ExecutionsClient`

Exceptions
Type	Description
`IOException`

create(ExecutionsSettings settings)

public static final ExecutionsClient create(ExecutionsSettings settings)

Constructs an instance of ExecutionsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`ExecutionsSettings`

Returns
Type	Description
`ExecutionsClient`

Exceptions
Type	Description
`IOException`

create(ExecutionsStub stub)

public static final ExecutionsClient create(ExecutionsStub stub)

Constructs an instance of ExecutionsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExecutionsSettings).

Parameter
Name	Description
`stub`	`ExecutionsStub`

Returns
Type	Description
`ExecutionsClient`

Constructors

ExecutionsClient(ExecutionsSettings settings)

protected ExecutionsClient(ExecutionsSettings settings)

Constructs an instance of ExecutionsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`ExecutionsSettings`

ExecutionsClient(ExecutionsStub stub)

protected ExecutionsClient(ExecutionsStub stub)

Parameter
Name	Description
`stub`	`ExecutionsStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

cancelExecution(CancelExecutionRequest request)

public final Execution cancelExecution(CancelExecutionRequest request)

Cancels an execution of the given name.

Sample code:


 // 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()) {
   CancelExecutionRequest request =
       CancelExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]")
                   .toString())
           .build();
   Execution response = executionsClient.cancelExecution(request);
 }

Parameter
Name	Description
`request`	`CancelExecutionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Execution`

cancelExecution(ExecutionName name)

public final Execution cancelExecution(ExecutionName name)

Cancels an execution of the given name.

Sample code:


 // 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()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]");
   Execution response = executionsClient.cancelExecution(name);
 }

Parameter
Name	Description
`name`	`ExecutionName` Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Returns
Type	Description
`Execution`

cancelExecution(String name)

public final Execution cancelExecution(String name)

Cancels an execution of the given name.

Sample code:


 // 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()) {
   String name =
       ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]").toString();
   Execution response = executionsClient.cancelExecution(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Returns
Type	Description
`Execution`

cancelExecutionCallable()

public final UnaryCallable<CancelExecutionRequest,Execution> cancelExecutionCallable()

Cancels an execution of the given name.

Sample code:


 // 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()) {
   CancelExecutionRequest request =
       CancelExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]")
                   .toString())
           .build();
   ApiFuture<Execution> future = executionsClient.cancelExecutionCallable().futureCall(request);
   // Do something.
   Execution response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CancelExecutionRequest,Execution>`

close()

public final void close()

createExecution(CreateExecutionRequest request)

public final Execution createExecution(CreateExecutionRequest request)

Creates a new execution using the latest revision of the given workflow.

Sample code:


 // 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()) {
   CreateExecutionRequest request =
       CreateExecutionRequest.newBuilder()
           .setParent(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setExecution(Execution.newBuilder().build())
           .build();
   Execution response = executionsClient.createExecution(request);
 }

Parameter
Name	Description
`request`	`CreateExecutionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Execution`

createExecution(WorkflowName parent, Execution execution)

public final Execution createExecution(WorkflowName parent, Execution execution)

Creates a new execution using the latest revision of the given workflow.

Sample code:


 // 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);
 }

Parameters
Name	Description
`parent`	`WorkflowName` Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.
`execution`	`Execution` Required. Execution to be created.

Returns
Type	Description
`Execution`

createExecution(String parent, Execution execution)

public final Execution createExecution(String parent, Execution execution)

Creates a new execution using the latest revision of the given workflow.

Sample code:


 // 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()) {
   String parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   Execution execution = Execution.newBuilder().build();
   Execution response = executionsClient.createExecution(parent, execution);
 }

Parameters
Name	Description
`parent`	`String` Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.
`execution`	`Execution` Required. Execution to be created.

Returns
Type	Description
`Execution`

createExecutionCallable()

public final UnaryCallable<CreateExecutionRequest,Execution> createExecutionCallable()

Creates a new execution using the latest revision of the given workflow.

Sample code:


 // 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()) {
   CreateExecutionRequest request =
       CreateExecutionRequest.newBuilder()
           .setParent(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setExecution(Execution.newBuilder().build())
           .build();
   ApiFuture<Execution> future = executionsClient.createExecutionCallable().futureCall(request);
   // Do something.
   Execution response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateExecutionRequest,Execution>`

getExecution(ExecutionName name)

public final Execution getExecution(ExecutionName name)

Returns an execution of the given name.

Sample code:


 // 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()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]");
   Execution response = executionsClient.getExecution(name);
 }

Parameter
Name	Description
`name`	`ExecutionName` Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Returns
Type	Description
`Execution`

getExecution(GetExecutionRequest request)

public final Execution getExecution(GetExecutionRequest request)

Returns an execution of the given name.

Sample code:


 // 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()) {
   GetExecutionRequest request =
       GetExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]")
                   .toString())
           .setView(ExecutionView.forNumber(0))
           .build();
   Execution response = executionsClient.getExecution(request);
 }

Parameter
Name	Description
`request`	`GetExecutionRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Execution`

getExecution(String name)

public final Execution getExecution(String name)

Returns an execution of the given name.

Sample code:


 // 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()) {
   String name =
       ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]").toString();
   Execution response = executionsClient.getExecution(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Returns
Type	Description
`Execution`

getExecutionCallable()

public final UnaryCallable<GetExecutionRequest,Execution> getExecutionCallable()

Returns an execution of the given name.

Sample code:


 // 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()) {
   GetExecutionRequest request =
       GetExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]")
                   .toString())
           .setView(ExecutionView.forNumber(0))
           .build();
   ApiFuture<Execution> future = executionsClient.getExecutionCallable().futureCall(request);
   // Do something.
   Execution response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetExecutionRequest,Execution>`

getSettings()

public final ExecutionsSettings getSettings()

Returns
Type	Description
`ExecutionsSettings`

getStub()

public ExecutionsStub getStub()

Returns
Type	Description
`ExecutionsStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listExecutions(ListExecutionsRequest request)

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(ListExecutionsRequest request)

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Sample code:


 // 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()) {
   ListExecutionsRequest request =
       ListExecutionsRequest.newBuilder()
           .setParent(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ExecutionView.forNumber(0))
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Execution element : executionsClient.listExecutions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListExecutionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ExecutionsClient.ListExecutionsPagedResponse`

listExecutions(WorkflowName parent)

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(WorkflowName parent)

Sample code:


 // 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]");
   for (Execution element : executionsClient.listExecutions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`WorkflowName` Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

Returns
Type	Description
`ExecutionsClient.ListExecutionsPagedResponse`

listExecutions(String parent)

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(String parent)

Sample code:


 // 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()) {
   String parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   for (Execution element : executionsClient.listExecutions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

Returns
Type	Description
`ExecutionsClient.ListExecutionsPagedResponse`

listExecutionsCallable()

public final UnaryCallable<ListExecutionsRequest,ListExecutionsResponse> listExecutionsCallable()

Sample code:


 // 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()) {
   ListExecutionsRequest request =
       ListExecutionsRequest.newBuilder()
           .setParent(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ExecutionView.forNumber(0))
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListExecutionsResponse response = executionsClient.listExecutionsCallable().call(request);
     for (Execution element : response.getExecutionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListExecutionsRequest,ListExecutionsResponse>`

listExecutionsPagedCallable()

public final UnaryCallable<ListExecutionsRequest,ExecutionsClient.ListExecutionsPagedResponse> listExecutionsPagedCallable()

Sample code:


 // 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()) {
   ListExecutionsRequest request =
       ListExecutionsRequest.newBuilder()
           .setParent(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ExecutionView.forNumber(0))
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Execution> future =
       executionsClient.listExecutionsPagedCallable().futureCall(request);
   // Do something.
   for (Execution element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListExecutionsRequest,ListExecutionsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()