Class WorkflowsClient (2.22.0-rc)

Workflows is used to deploy and execute workflow programs.

Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

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

WorkflowsClient(WorkflowsClient const &)

Copy and move support

Parameter
NameDescription
WorkflowsClient const &

WorkflowsClient(WorkflowsClient &&)

Copy and move support

Parameter
NameDescription
WorkflowsClient &&

WorkflowsClient(std::shared_ptr< WorkflowsConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< WorkflowsConnection >
opts Options

Operators

operator=(WorkflowsClient const &)

Copy and move support

Parameter
NameDescription
WorkflowsClient const &
Returns
TypeDescription
WorkflowsClient &

operator=(WorkflowsClient &&)

Copy and move support

Parameter
NameDescription
WorkflowsClient &&
Returns
TypeDescription
WorkflowsClient &

Functions

ListWorkflows(std::string const &, Options)

Lists workflows in a given project and location.

The default order is not specified.

Parameters
NameDescription
parent std::string const &

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

opts Options

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

Returns
TypeDescription
StreamRange< google::cloud::workflows::v1::Workflow >

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.v1.Workflow, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListWorkflows(google::cloud::workflows::v1::ListWorkflowsRequest, Options)

Lists workflows in a given project and location.

The default order is not specified.

Parameters
NameDescription
request google::cloud::workflows::v1::ListWorkflowsRequest

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.v1.ListWorkflowsRequest. 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
TypeDescription
StreamRange< google::cloud::workflows::v1::Workflow >

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.v1.Workflow, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetWorkflow(std::string const &, Options)

Gets details of a single workflow.

Parameters
NameDescription
name std::string const &

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

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::workflows::v1::Workflow >

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

GetWorkflow(google::cloud::workflows::v1::GetWorkflowRequest const &, Options)

Gets details of a single workflow.

Parameters
NameDescription
request google::cloud::workflows::v1::GetWorkflowRequest 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.v1.GetWorkflowRequest. 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
TypeDescription
StatusOr< google::cloud::workflows::v1::Workflow >

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

CreateWorkflow(std::string const &, google::cloud::workflows::v1::Workflow const &, std::string const &, Options)

Creates a new workflow.

If a workflow with the specified name already exists in the specified project and location, the long running operation returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.

Parameters
NameDescription
parent std::string const &

Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}

workflow google::cloud::workflows::v1::Workflow const &

Required. Workflow to be created.

workflow_id std::string const &

Required. The ID of the workflow to be created. It has to fulfill the following requirements:

  • Must contain only letters, numbers, underscores and hyphens.
  • Must start with a letter.
  • Must be between 1-64 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project and location.
opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::workflows::v1::Workflow > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workflows.v1.Workflow proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkflow(google::cloud::workflows::v1::CreateWorkflowRequest const &, Options)

Creates a new workflow.

If a workflow with the specified name already exists in the specified project and location, the long running operation returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.

Parameters
NameDescription
request google::cloud::workflows::v1::CreateWorkflowRequest 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.v1.CreateWorkflowRequest. 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
TypeDescription
future< StatusOr< google::cloud::workflows::v1::Workflow > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workflows.v1.Workflow proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkflow(std::string const &, Options)

Deletes a workflow with the specified name.

This method also cancels and deletes all running executions of the workflow.

Parameters
NameDescription
name std::string const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::workflows::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workflows.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkflow(google::cloud::workflows::v1::DeleteWorkflowRequest const &, Options)

Deletes a workflow with the specified name.

This method also cancels and deletes all running executions of the workflow.

Parameters
NameDescription
request google::cloud::workflows::v1::DeleteWorkflowRequest 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.v1.DeleteWorkflowRequest. 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
TypeDescription
future< StatusOr< google::cloud::workflows::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workflows.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkflow(google::cloud::workflows::v1::Workflow const &, google::protobuf::FieldMask const &, Options)

Updates an existing workflow.

Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.

Parameters
NameDescription
workflow google::cloud::workflows::v1::Workflow const &

Required. Workflow to be updated.

update_mask google::protobuf::FieldMask const &

List of fields to be updated. If not present, the entire workflow will be updated.

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::workflows::v1::Workflow > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workflows.v1.Workflow proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkflow(google::cloud::workflows::v1::UpdateWorkflowRequest const &, Options)

Updates an existing workflow.

Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.

Parameters
NameDescription
request google::cloud::workflows::v1::UpdateWorkflowRequest 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.v1.UpdateWorkflowRequest. 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
TypeDescription
future< StatusOr< google::cloud::workflows::v1::Workflow > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workflows.v1.Workflow proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.