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

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

@Generated("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.v1.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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ExecutionsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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	Description
`static class`	`ExecutionsClient.ListExecutionsFixedSizeCollection`
`static class`	`ExecutionsClient.ListExecutionsPage`
`static class`	`ExecutionsClient.ListExecutionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor	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	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(WorkflowName parent, Execution execution)`	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.
`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(WorkflowName parent)`	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.
`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()
```