Class ExecutionsClient (0.11.0)

Version 0.11.0

• 0.54.0 (latest)
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5
• 0.2.1
• 0.1.2

public class ExecutionsClient implements BackgroundResource

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]");
   Execution response = 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
 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

close()

public final void close()

deleteExecutionAsync(DeleteExecutionRequest request)

public final OperationFuture<Execution,Execution> deleteExecutionAsync(DeleteExecutionRequest request)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   DeleteExecutionRequest request =
       DeleteExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   Execution response = 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)

public final OperationFuture<Execution,Execution> deleteExecutionAsync(ExecutionName name)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]");
   Execution response = 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)

public final OperationFuture<Execution,Execution> deleteExecutionAsync(String name)

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

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

Returns

Type	Description
UnaryCallable<DeleteExecutionRequest,Operation>

deleteExecutionOperationCallable()

public final OperationCallable<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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   DeleteExecutionRequest request =
       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.
   Execution response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteExecutionRequest,Execution,Execution>

getExecution(ExecutionName name)

public final Execution getExecution(ExecutionName name)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]");
   Execution response = 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)

public final Execution getExecution(GetExecutionRequest request)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   GetExecutionRequest request =
       GetExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString())
           .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)

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

public final UnaryCallable<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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   GetExecutionRequest request =
       GetExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString())
           .build();
   ApiFuture<Execution> future = executionsClient.getExecutionCallable().futureCall(request);
   // Do something.
   Execution response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetExecutionRequest,Execution>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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()

public final OperationsClient getOperationsClient()

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()

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(JobName parent)

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(JobName parent)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   JobName parent = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   for (Execution element : 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)

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(ListExecutionsRequest request)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ListExecutionsRequest request =
       ListExecutionsRequest.newBuilder()
           .setParent(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .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(String parent)

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(String parent)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   String parent = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   for (Execution element : 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()

public final UnaryCallable<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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ListExecutionsRequest request =
       ListExecutionsRequest.newBuilder()
           .setParent(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .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()

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ListExecutionsRequest request =
       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 (Execution element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListExecutionsRequest,ListExecutionsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()