Class ExecutionsClient (2.12.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 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.7
publicclass ExecutionsClientimplementsBackgroundResourceService 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:
- 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
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.
Implements
BackgroundResourceInherited Members
Static Methods
create()
publicstaticfinalExecutionsClientcreate()Constructs an instance of ExecutionsClient with default settings.
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.
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).
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.
ExecutionsClient(ExecutionsStub stub)
protectedExecutionsClient(ExecutionsStubstub)Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)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);
}
request
CancelExecutionRequest The request object containing all of the parameters for the API call.
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);
}
name
ExecutionName Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
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);
}
name
String Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
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();
}
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);
}
request
CreateExecutionRequest The request object containing all of the parameters for the API call.
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);
}
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.
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);
}
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.
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();
}
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);
}
name
ExecutionName Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
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);
}
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);
}
name
String Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
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();
}
getSettings()
publicfinalExecutionsSettingsgetSettings()getStub()
publicExecutionsStubgetStub()isShutdown()
publicbooleanisShutdown()isTerminated()
publicbooleanisTerminated()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);
}
}
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);
}
}
parent
WorkflowName Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
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);
}
}
parent
String Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
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;
}
}
}
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);
}
}
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()