ExecutionsClient (Google Cloud Workflow Executions 2.33.0 API)

java.lang.Object
- com.google.cloud.workflows.executions.v1beta.ExecutionsClient

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

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ExecutionsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Executions is used to start and manage running instances of [Workflows][google.cloud.workflows.v1beta.Workflow] 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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   WorkflowName parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   Execution execution = Execution.newBuilder().build();
   Execution response = 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().

Method	Description	Method Variants
ListExecutions	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).	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(WorkflowName 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()
CreateExecution	Creates a new execution using the latest revision of the given workflow.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createExecution(CreateExecutionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createExecution(WorkflowName parent, Execution execution) createExecution(String parent, Execution execution) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createExecutionCallable()
GetExecution	Returns an execution of the given name.	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()
CancelExecution	Cancels an execution of the given name.	Request object method variants only take one parameter, a request object, which must be constructed before the call. cancelExecution(CancelExecutionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. cancelExecution(ExecutionName name) cancelExecution(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. 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)`
`Execution`	`cancelExecution(CancelExecutionRequest request)` Cancels an execution of the given name.
`Execution`	`cancelExecution(ExecutionName name)` Cancels an execution of the given name.
`Execution`	`cancelExecution(String name)` Cancels an execution of the given name.
`com.google.api.gax.rpc.UnaryCallable<CancelExecutionRequest,Execution>`	`cancelExecutionCallable()` Cancels an execution of the given name.
`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.
`Execution`	`createExecution(CreateExecutionRequest request)` Creates a new execution using the latest revision of the given workflow.
`Execution`	`createExecution(String parent, Execution execution)` Creates a new execution using the latest revision of the given workflow.
`Execution`	`createExecution(WorkflowName parent, Execution execution)` Creates a new execution using the latest revision of the given workflow.
`com.google.api.gax.rpc.UnaryCallable<CreateExecutionRequest,Execution>`	`createExecutionCallable()` Creates a new execution using the latest revision of the given workflow.
`Execution`	`getExecution(ExecutionName name)` Returns an execution of the given name.
`Execution`	`getExecution(GetExecutionRequest request)` Returns an execution of the given name.
`Execution`	`getExecution(String name)` Returns an execution of the given name.
`com.google.api.gax.rpc.UnaryCallable<GetExecutionRequest,Execution>`	`getExecutionCallable()` Returns an execution of the given name.
`ExecutionsSettings`	`getSettings()`
`ExecutionsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ExecutionsClient.ListExecutionsPagedResponse`	`listExecutions(ListExecutionsRequest request)` Returns a list of executions which belong to the workflow with the given name.
`ExecutionsClient.ListExecutionsPagedResponse`	`listExecutions(String parent)` Returns a list of executions which belong to the workflow with the given name.
`ExecutionsClient.ListExecutionsPagedResponse`	`listExecutions(WorkflowName parent)` Returns a list of executions which belong to the workflow with the given name.
`com.google.api.gax.rpc.UnaryCallable<ListExecutionsRequest,ListExecutionsResponse>`	`listExecutionsCallable()` Returns a list of executions which belong to the workflow with the given name.
`com.google.api.gax.rpc.UnaryCallable<ListExecutionsRequest,ExecutionsClient.ListExecutionsPagedResponse>`	`listExecutionsPagedCallable()` Returns a list of executions which belong to the workflow with the given name.
`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()
```

listExecutions

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(WorkflowName parent)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   WorkflowName parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   for (Execution element : executionsClient.listExecutions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listExecutions

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(String parent)

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 = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   for (Execution element : executionsClient.listExecutions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listExecutions

public final ExecutionsClient.ListExecutionsPagedResponse listExecutions(ListExecutionsRequest request)

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(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ExecutionView.forNumber(0))
           .build();
   for (Execution element : executionsClient.listExecutions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

listExecutionsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListExecutionsRequest,ExecutionsClient.ListExecutionsPagedResponse> listExecutionsPagedCallable()

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(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 (Execution element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listExecutionsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListExecutionsRequest,ListExecutionsResponse> listExecutionsCallable()

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(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ExecutionView.forNumber(0))
           .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;
     }
   }
 }

createExecution

public final Execution createExecution(WorkflowName parent,
                                       Execution execution)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   WorkflowName parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   Execution execution = Execution.newBuilder().build();
   Execution response = executionsClient.createExecution(parent, execution);
 }

Parameters:: parent - 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 - Required. Execution to be created.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createExecution

public final Execution createExecution(String parent,
                                       Execution execution)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   String parent = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString();
   Execution execution = Execution.newBuilder().build();
   Execution response = executionsClient.createExecution(parent, execution);
 }

Parameters:: parent - 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 - Required. Execution to be created.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createExecution

public final Execution createExecution(CreateExecutionRequest request)

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

createExecutionCallable

public final com.google.api.gax.rpc.UnaryCallable<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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   CreateExecutionRequest request =
       CreateExecutionRequest.newBuilder()
           .setParent(WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]").toString())
           .setExecution(Execution.newBuilder().build())
           .build();
   ApiFuture<Execution> future = executionsClient.createExecutionCallable().futureCall(request);
   // Do something.
   Execution response = future.get();
 }

getExecution

public final Execution getExecution(ExecutionName name)

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

Parameters:: name - Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getExecution

public final Execution getExecution(String name)

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

Parameters:: name - Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getExecution

public final Execution getExecution(GetExecutionRequest request)

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

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

cancelExecution

public final Execution cancelExecution(ExecutionName name)

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

Parameters:: name - Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

cancelExecution

public final Execution cancelExecution(String name)

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

Parameters:: name - Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

cancelExecution

public final Execution cancelExecution(CancelExecutionRequest request)

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 (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   CancelExecutionRequest request =
       CancelExecutionRequest.newBuilder()
           .setName(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[EXECUTION]")
                   .toString())
           .build();
   Execution response = executionsClient.cancelExecution(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

cancelExecutionCallable

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

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class ExecutionsClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExecutionsClient

ExecutionsClient

Method Detail

create

create

create

getSettings

getStub

listExecutions

listExecutions

listExecutions

listExecutionsPagedCallable

listExecutionsCallable

createExecution

createExecution

createExecution

createExecutionCallable

getExecution

getExecution

getExecution

getExecutionCallable

cancelExecution

cancelExecution

cancelExecution

cancelExecutionCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination