Class ExecutionsClient (2.12.0)

publicclass ExecutionsClientimplementsBackgroundResource

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
WorkflowNameparent=WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
Executionexecution=Execution.newBuilder().build();
Executionresponse=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:

  1. 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.
  2. 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.
  3. 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
ExecutionsSettingsexecutionsSettings=
ExecutionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ExecutionsClientexecutionsClient=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
ExecutionsSettingsexecutionsSettings=
ExecutionsSettings.newBuilder().setEndpoint(myEndpoint).build();
ExecutionsClientexecutionsClient=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
ExecutionsSettingsexecutionsSettings=ExecutionsSettings.newHttpJsonBuilder().build();
ExecutionsClientexecutionsClient=ExecutionsClient.create(executionsSettings);

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

Inheritance

java.lang.Object > ExecutionsClient

Implements

BackgroundResource

Static Methods

create()

publicstaticfinalExecutionsClientcreate()

Constructs an instance of ExecutionsClient with default settings.

Returns
Type Description
Exceptions
Type Description

create(ExecutionsSettings settings)

publicstaticfinalExecutionsClientcreate(ExecutionsSettingssettings)

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
Returns
Type Description
Exceptions
Type Description

create(ExecutionsStub stub)

publicstaticfinalExecutionsClientcreate(ExecutionsStubstub)

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

Parameter
Name Description
Returns
Type Description

Constructors

ExecutionsClient(ExecutionsSettings settings)

protectedExecutionsClient(ExecutionsSettingssettings)

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

ExecutionsClient(ExecutionsStub stub)

protectedExecutionsClient(ExecutionsStubstub)
Parameter
Name Description

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
Exceptions
Type Description

cancelExecution(CancelExecutionRequest request)

publicfinalExecutioncancelExecution(CancelExecutionRequestrequest)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
CancelExecutionRequestrequest=
CancelExecutionRequest.newBuilder()
.setName(
ExecutionName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[EXECUTION]")
.toString())
.build();
Executionresponse=executionsClient.cancelExecution(request);
}
Parameter
Name Description
request CancelExecutionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

cancelExecution(ExecutionName name)

publicfinalExecutioncancelExecution(ExecutionNamename)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
ExecutionNamename=ExecutionName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[EXECUTION]");
Executionresponse=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

cancelExecution(String name)

publicfinalExecutioncancelExecution(Stringname)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
Stringname=
ExecutionName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[EXECUTION]").toString();
Executionresponse=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

cancelExecutionCallable()

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

close()

publicfinalvoidclose()

createExecution(CreateExecutionRequest request)

publicfinalExecutioncreateExecution(CreateExecutionRequestrequest)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
CreateExecutionRequestrequest=
CreateExecutionRequest.newBuilder()
.setParent(WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setExecution(Execution.newBuilder().build())
.build();
Executionresponse=executionsClient.createExecution(request);
}
Parameter
Name Description
request CreateExecutionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

createExecution(WorkflowName parent, Execution execution)

publicfinalExecutioncreateExecution(WorkflowNameparent,Executionexecution)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
WorkflowNameparent=WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
Executionexecution=Execution.newBuilder().build();
Executionresponse=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

createExecution(String parent, Execution execution)

publicfinalExecutioncreateExecution(Stringparent,Executionexecution)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
Stringparent=WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString();
Executionexecution=Execution.newBuilder().build();
Executionresponse=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

createExecutionCallable()

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

getExecution(ExecutionName name)

publicfinalExecutiongetExecution(ExecutionNamename)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
ExecutionNamename=ExecutionName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[EXECUTION]");
Executionresponse=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

getExecution(GetExecutionRequest request)

publicfinalExecutiongetExecution(GetExecutionRequestrequest)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
GetExecutionRequestrequest=
GetExecutionRequest.newBuilder()
.setName(
ExecutionName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[EXECUTION]")
.toString())
.setView(ExecutionView.forNumber(0))
.build();
Executionresponse=executionsClient.getExecution(request);
}
Parameter
Name Description
request GetExecutionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description

getExecution(String name)

publicfinalExecutiongetExecution(Stringname)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
Stringname=
ExecutionName.of("[PROJECT]","[LOCATION]","[WORKFLOW]","[EXECUTION]").toString();
Executionresponse=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

getExecutionCallable()

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

getSettings()

publicfinalExecutionsSettingsgetSettings()
Returns
Type Description

getStub()

publicExecutionsStubgetStub()
Returns
Type Description

isShutdown()

publicbooleanisShutdown()
Returns
Type Description

isTerminated()

publicbooleanisTerminated()
Returns
Type Description

listExecutions(ListExecutionsRequest request)

publicfinalExecutionsClient.ListExecutionsPagedResponselistExecutions(ListExecutionsRequestrequest)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
ListExecutionsRequestrequest=
ListExecutionsRequest.newBuilder()
.setParent(WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setView(ExecutionView.forNumber(0))
.build();
for(Executionelement: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

listExecutions(WorkflowName parent)

publicfinalExecutionsClient.ListExecutionsPagedResponselistExecutions(WorkflowNameparent)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
WorkflowNameparent=WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]");
for(Executionelement: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

listExecutions(String parent)

publicfinalExecutionsClient.ListExecutionsPagedResponselistExecutions(Stringparent)

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
Stringparent=WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString();
for(Executionelement: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

listExecutionsCallable()

publicfinalUnaryCallable<ListExecutionsRequest,ListExecutionsResponse>listExecutionsCallable()

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
ListExecutionsRequestrequest=
ListExecutionsRequest.newBuilder()
.setParent(WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setView(ExecutionView.forNumber(0))
.build();
while(true){
ListExecutionsResponseresponse=executionsClient.listExecutionsCallable().call(request);
for(Executionelement:response.getExecutionsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description

listExecutionsPagedCallable()

publicfinalUnaryCallable<ListExecutionsRequest,ExecutionsClient.ListExecutionsPagedResponse>listExecutionsPagedCallable()

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(ExecutionsClientexecutionsClient=ExecutionsClient.create()){
ListExecutionsRequestrequest=
ListExecutionsRequest.newBuilder()
.setParent(WorkflowName.of("[PROJECT]","[LOCATION]","[WORKFLOW]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setView(ExecutionView.forNumber(0))
.build();
ApiFuture<Execution>future=
executionsClient.listExecutionsPagedCallable().futureCall(request);
// Do something.
for(Executionelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.