Class ExecutionsClient (2.27.0-rc)

Executions is used to start and manage running instances of [Workflows][google.cloud.workflows.v1.Workflow] called executions.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ExecutionsClient(ExecutionsClient const &)

Copy and move support

Parameter
Name Description
ExecutionsClient const &

ExecutionsClient(ExecutionsClient &&)

Copy and move support

Parameter
Name Description
ExecutionsClient &&

ExecutionsClient(std::shared_ptr< ExecutionsConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< ExecutionsConnection >
opts Options

Operators

operator=(ExecutionsClient const &)

Copy and move support

Parameter
Name Description
ExecutionsClient const &
Returns
Type Description
ExecutionsClient &

operator=(ExecutionsClient &&)

Copy and move support

Parameter
Name Description
ExecutionsClient &&
Returns
Type Description
ExecutionsClient &

Functions

ListExecutions(std::string const &, Options)

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

Parameters
Name Description
parent std::string const &

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::workflows::executions::v1::Execution >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workflows.executions.v1.Execution, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListExecutions(google::cloud::workflows::executions::v1::ListExecutionsRequest, Options)

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

Parameters
Name Description
request google::cloud::workflows::executions::v1::ListExecutionsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workflows.executions.v1.ListExecutionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::workflows::executions::v1::Execution >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workflows.executions.v1.Execution, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateExecution(std::string const &, google::cloud::workflows::executions::v1::Execution const &, Options)

Creates a new execution using the latest revision of the given workflow.

Parameters
Name Description
parent std::string const &

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 google::cloud::workflows::executions::v1::Execution const &

Required. Execution to be created.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::workflows::executions::v1::Execution >

the result of the RPC. The response message type (google.cloud.workflows.executions.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateExecution(google::cloud::workflows::executions::v1::CreateExecutionRequest const &, Options)

Creates a new execution using the latest revision of the given workflow.

Parameters
Name Description
request google::cloud::workflows::executions::v1::CreateExecutionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workflows.executions.v1.CreateExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::workflows::executions::v1::Execution >

the result of the RPC. The response message type (google.cloud.workflows.executions.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetExecution(std::string const &, Options)

Returns an execution of the given name.

Parameters
Name Description
name std::string const &

Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::workflows::executions::v1::Execution >

the result of the RPC. The response message type (google.cloud.workflows.executions.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetExecution(google::cloud::workflows::executions::v1::GetExecutionRequest const &, Options)

Returns an execution of the given name.

Parameters
Name Description
request google::cloud::workflows::executions::v1::GetExecutionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workflows.executions.v1.GetExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::workflows::executions::v1::Execution >

the result of the RPC. The response message type (google.cloud.workflows.executions.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CancelExecution(std::string const &, Options)

Cancels an execution of the given name.

Parameters
Name Description
name std::string const &

Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::workflows::executions::v1::Execution >

the result of the RPC. The response message type (google.cloud.workflows.executions.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CancelExecution(google::cloud::workflows::executions::v1::CancelExecutionRequest const &, Options)

Cancels an execution of the given name.

Parameters
Name Description
request google::cloud::workflows::executions::v1::CancelExecutionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workflows.executions.v1.CancelExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::workflows::executions::v1::Execution >

the result of the RPC. The response message type (google.cloud.workflows.executions.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.