ExecutionsClient (Google Cloud Run 0.67.0 API)

java.lang.Object
- com.google.cloud.run.v2.ExecutionsClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ExecutionsClient
extends Object
implements com.google.api.gax.core.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().

Methods
Method	Description	Method Variants
GetExecution	Gets information about an Execution.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getExecution(GetExecutionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getExecution(ExecutionName name) getExecution(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getExecutionCallable()
ListExecutions	Lists Executions from a Job. Results are sorted by creation time, descending.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listExecutions(ListExecutionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listExecutions(JobName parent) listExecutions(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listExecutionsPagedCallable() listExecutionsCallable()
DeleteExecution	Deletes an Execution.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteExecutionAsync(DeleteExecutionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteExecutionAsync(ExecutionName name) deleteExecutionAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteExecutionOperationCallable() deleteExecutionCallable()
CancelExecution	Cancels an Execution.	Request object method variants only take one parameter, a request object, which must be constructed before the call. cancelExecutionAsync(CancelExecutionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. cancelExecutionAsync(ExecutionName name) cancelExecutionAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. cancelExecutionOperationCallable() cancelExecutionCallable()

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExecutionsClient.ListExecutionsFixedSizeCollection`
`static class`	`ExecutionsClient.ListExecutionsPage`
`static class`	`ExecutionsClient.ListExecutionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ExecutionsClient(ExecutionsSettings settings)` Constructs an instance of ExecutionsClient, using the given settings.
`protected`	`ExecutionsClient(ExecutionsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.api.gax.longrunning.OperationFuture<Execution,Execution>`	`cancelExecutionAsync(CancelExecutionRequest request)` Cancels an Execution.
`com.google.api.gax.longrunning.OperationFuture<Execution,Execution>`	`cancelExecutionAsync(ExecutionName name)` Cancels an Execution.
`com.google.api.gax.longrunning.OperationFuture<Execution,Execution>`	`cancelExecutionAsync(String name)` Cancels an Execution.
`com.google.api.gax.rpc.UnaryCallable<CancelExecutionRequest,com.google.longrunning.Operation>`	`cancelExecutionCallable()` Cancels an Execution.
`com.google.api.gax.rpc.OperationCallable<CancelExecutionRequest,Execution,Execution>`	`cancelExecutionOperationCallable()` Cancels an Execution.
`void`	`close()`
`static ExecutionsClient`	`create()` Constructs an instance of ExecutionsClient with default settings.
`static ExecutionsClient`	`create(ExecutionsSettings settings)` Constructs an instance of ExecutionsClient, using the given settings.
`static ExecutionsClient`	`create(ExecutionsStub stub)` Constructs an instance of ExecutionsClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Execution,Execution>`	`deleteExecutionAsync(DeleteExecutionRequest request)` Deletes an Execution.
`com.google.api.gax.longrunning.OperationFuture<Execution,Execution>`	`deleteExecutionAsync(ExecutionName name)` Deletes an Execution.
`com.google.api.gax.longrunning.OperationFuture<Execution,Execution>`	`deleteExecutionAsync(String name)` Deletes an Execution.
`com.google.api.gax.rpc.UnaryCallable<DeleteExecutionRequest,com.google.longrunning.Operation>`	`deleteExecutionCallable()` Deletes an Execution.
`com.google.api.gax.rpc.OperationCallable<DeleteExecutionRequest,Execution,Execution>`	`deleteExecutionOperationCallable()` Deletes an Execution.
`Execution`	`getExecution(ExecutionName name)` Gets information about an Execution.
`Execution`	`getExecution(GetExecutionRequest request)` Gets information about an Execution.
`Execution`	`getExecution(String name)` Gets information about an Execution.
`com.google.api.gax.rpc.UnaryCallable<GetExecutionRequest,Execution>`	`getExecutionCallable()` Gets information about an Execution.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`ExecutionsSettings`	`getSettings()`
`ExecutionsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ExecutionsClient.ListExecutionsPagedResponse`	`listExecutions(JobName parent)` Lists Executions from a Job.
`ExecutionsClient.ListExecutionsPagedResponse`	`listExecutions(ListExecutionsRequest request)` Lists Executions from a Job.
`ExecutionsClient.ListExecutionsPagedResponse`	`listExecutions(String parent)` Lists Executions from a Job.
`com.google.api.gax.rpc.UnaryCallable<ListExecutionsRequest,ListExecutionsResponse>`	`listExecutionsCallable()` Lists Executions from a Job.
`com.google.api.gax.rpc.UnaryCallable<ListExecutionsRequest,ExecutionsClient.ListExecutionsPagedResponse>`	`listExecutionsPagedCallable()` Lists Executions from a Job.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ExecutionsClient
```
protected ExecutionsClient(ExecutionsSettings settings)
                    throws IOException
```
  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.
  
  Throws:
  
  IOException
- ExecutionsClient
```
protected ExecutionsClient(ExecutionsStub stub)
```

Method Detail

create

public static final ExecutionsClient create()
                                     throws IOException

Constructs an instance of ExecutionsClient with default settings.

Throws:: IOException

create
```
public static final ExecutionsClient create(ExecutionsSettings settings)
                                     throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final ExecutionsSettings getSettings()

getStub
```
public ExecutionsStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getExecution

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

Parameters:: name - Required. The full name of the Execution. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getExecution

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

Parameters:: name - Required. The full name of the Execution. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getExecution

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

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getExecutionCallable

public final com.google.api.gax.rpc.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();
 }