Class ExecutionsClient (0.14.0)

publicclass ExecutionsClientimplementsBackgroundResource

Service Description: Cloud Run Execution Control Plane API.

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()){
ExecutionNamename=ExecutionName.of("[PROJECT]","[LOCATION]","[JOB]","[EXECUTION]");
Executionresponse=executionsClient.getExecution(name);
}

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
ExecutionsClient
Exceptions
Type Description
IOException

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
settings ExecutionsSettings
Returns
Type Description
ExecutionsClient
Exceptions
Type Description
IOException

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
stub ExecutionsStub
Returns
Type Description
ExecutionsClient

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
settings ExecutionsSettings

ExecutionsClient(ExecutionsStub stub)

protectedExecutionsClient(ExecutionsStubstub)
Parameter
Name Description
stub ExecutionsStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

publicfinalvoidclose()

deleteExecutionAsync(DeleteExecutionRequest request)

publicfinalOperationFuture<Execution,Execution>deleteExecutionAsync(DeleteExecutionRequestrequest)

Deletes an Execution.

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()){
DeleteExecutionRequestrequest=
DeleteExecutionRequest.newBuilder()
.setName(
ExecutionName.of("[PROJECT]","[LOCATION]","[JOB]","[EXECUTION]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
Executionresponse=executionsClient.deleteExecutionAsync(request).get();
}
Parameter
Name Description
request DeleteExecutionRequest

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

Returns
Type Description
OperationFuture<Execution,Execution>

deleteExecutionAsync(ExecutionName name)

publicfinalOperationFuture<Execution,Execution>deleteExecutionAsync(ExecutionNamename)

Deletes an Execution.

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]","[JOB]","[EXECUTION]");
Executionresponse=executionsClient.deleteExecutionAsync(name).get();
}
Parameter
Name Description
name ExecutionName

Required. The name of the Execution to delete. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.

Returns
Type Description
OperationFuture<Execution,Execution>

deleteExecutionAsync(String name)

publicfinalOperationFuture<Execution,Execution>deleteExecutionAsync(Stringname)

Deletes an Execution.

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]","[JOB]","[EXECUTION]").toString();
Executionresponse=executionsClient.deleteExecutionAsync(name).get();
}
Parameter
Name Description
name String

Required. The name of the Execution to delete. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.

Returns
Type Description
OperationFuture<Execution,Execution>

deleteExecutionCallable()

publicfinalUnaryCallable<DeleteExecutionRequest,Operation>deleteExecutionCallable()

Deletes an Execution.

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()){
DeleteExecutionRequestrequest=
DeleteExecutionRequest.newBuilder()
.setName(
ExecutionName.of("[PROJECT]","[LOCATION]","[JOB]","[EXECUTION]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
ApiFuture<Operation>future=executionsClient.deleteExecutionCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description
UnaryCallable<DeleteExecutionRequest,Operation>

deleteExecutionOperationCallable()

publicfinalOperationCallable<DeleteExecutionRequest,Execution,Execution>deleteExecutionOperationCallable()

Deletes an Execution.

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()){
DeleteExecutionRequestrequest=
DeleteExecutionRequest.newBuilder()
.setName(
ExecutionName.of("[PROJECT]","[LOCATION]","[JOB]","[EXECUTION]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
OperationFuture<Execution,Execution>future=
executionsClient.deleteExecutionOperationCallable().futureCall(request);
// Do something.
Executionresponse=future.get();
}
Returns
Type Description
OperationCallable<DeleteExecutionRequest,Execution,Execution>

getExecution(ExecutionName name)

publicfinalExecutiongetExecution(ExecutionNamename)

Gets information about an Execution.

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]","[JOB]","[EXECUTION]");
Executionresponse=executionsClient.getExecution(name);
}
Parameter
Name Description
name ExecutionName

Required. The full name of the Execution. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.

Returns
Type Description
Execution

getExecution(GetExecutionRequest request)

publicfinalExecutiongetExecution(GetExecutionRequestrequest)

Gets information about an Execution.

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]","[JOB]","[EXECUTION]").toString())
.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
Execution

getExecution(String name)

publicfinalExecutiongetExecution(Stringname)

Gets information about an Execution.

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]","[JOB]","[EXECUTION]").toString();
Executionresponse=executionsClient.getExecution(name);
}
Parameter
Name Description
name String

Required. The full name of the Execution. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.

Returns
Type Description
Execution

getExecutionCallable()

publicfinalUnaryCallable<GetExecutionRequest,Execution>getExecutionCallable()

Gets information about an Execution.

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]","[JOB]","[EXECUTION]").toString())
.build();
ApiFuture<Execution>future=executionsClient.getExecutionCallable().futureCall(request);
// Do something.
Executionresponse=future.get();
}
Returns
Type Description
UnaryCallable<GetExecutionRequest,Execution>

getHttpJsonOperationsClient()

publicfinalOperationsClientgetHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getOperationsClient()

publicfinalOperationsClientgetOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

publicfinalExecutionsSettingsgetSettings()
Returns
Type Description
ExecutionsSettings

getStub()

publicExecutionsStubgetStub()
Returns
Type Description
ExecutionsStub

isShutdown()

publicbooleanisShutdown()
Returns
Type Description
boolean

isTerminated()

publicbooleanisTerminated()
Returns
Type Description
boolean

listExecutions(JobName parent)

publicfinalExecutionsClient.ListExecutionsPagedResponselistExecutions(JobNameparent)

Lists Executions from a Job.

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()){
JobNameparent=JobName.of("[PROJECT]","[LOCATION]","[JOB]");
for(Executionelement:executionsClient.listExecutions(parent).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
parent JobName

Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type Description
ExecutionsClient.ListExecutionsPagedResponse

listExecutions(ListExecutionsRequest request)

publicfinalExecutionsClient.ListExecutionsPagedResponselistExecutions(ListExecutionsRequestrequest)

Lists Executions from a Job.

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(JobName.of("[PROJECT]","[LOCATION]","[JOB]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.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
ExecutionsClient.ListExecutionsPagedResponse

listExecutions(String parent)

publicfinalExecutionsClient.ListExecutionsPagedResponselistExecutions(Stringparent)

Lists Executions from a Job.

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=JobName.of("[PROJECT]","[LOCATION]","[JOB]").toString();
for(Executionelement:executionsClient.listExecutions(parent).iterateAll()){
// doThingsWith(element);
}
}
Parameter
Name Description
parent String

Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
Type Description
ExecutionsClient.ListExecutionsPagedResponse

listExecutionsCallable()

publicfinalUnaryCallable<ListExecutionsRequest,ListExecutionsResponse>listExecutionsCallable()

Lists Executions from a Job.

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(JobName.of("[PROJECT]","[LOCATION]","[JOB]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.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
UnaryCallable<ListExecutionsRequest,ListExecutionsResponse>

listExecutionsPagedCallable()

publicfinalUnaryCallable<ListExecutionsRequest,ExecutionsClient.ListExecutionsPagedResponse>listExecutionsPagedCallable()

Lists Executions from a Job.

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(JobName.of("[PROJECT]","[LOCATION]","[JOB]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
ApiFuture<Execution>future=
executionsClient.listExecutionsPagedCallable().futureCall(request);
// Do something.
for(Executionelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description
UnaryCallable<ListExecutionsRequest,ListExecutionsPagedResponse>

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年10月30日 UTC.