Class PipelineServiceClient (2.32.0-rc)

Version latest

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0

This service lets you manage pipelines.

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

PipelineServiceClient(PipelineServiceClient const &)

Copy and move support

Parameter
Name	Description
	PipelineServiceClient const &

PipelineServiceClient(PipelineServiceClient &&)

Copy and move support

Parameter
Name	Description
	PipelineServiceClient &&

PipelineServiceClient(std::shared_ptr< PipelineServiceConnection >, Options)

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

Operators

operator=(PipelineServiceClient const &)

Copy and move support

Parameter
Name	Description
	PipelineServiceClient const &

Returns
Type	Description
PipelineServiceClient &

operator=(PipelineServiceClient &&)

Copy and move support

Parameter
Name	Description
	PipelineServiceClient &&

Returns
Type	Description
PipelineServiceClient &

Functions

RunPipeline(std::string const &, Options)

Run a predefined pipeline.

Parameters
Name	Description
name	std::string const & Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::contentwarehouse::v1::RunPipelineResponse > >	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.contentwarehouse.v1.RunPipelineResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RunPipeline(NoAwaitTag, std::string const &, Options)

Run a predefined pipeline.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

RunPipeline(google::cloud::contentwarehouse::v1::RunPipelineRequest const &, Options)

Run a predefined pipeline.

Parameters
Name	Description
request	google::cloud::contentwarehouse::v1::RunPipelineRequest 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.contentwarehouse.v1.RunPipelineRequest. 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
future< StatusOr< google::cloud::contentwarehouse::v1::RunPipelineResponse > >	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.contentwarehouse.v1.RunPipelineResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RunPipeline(NoAwaitTag, google::cloud::contentwarehouse::v1::RunPipelineRequest const &, Options)

Run a predefined pipeline.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::contentwarehouse::v1::RunPipelineRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

RunPipeline(google::longrunning::Operation const &, Options)

Run a predefined pipeline.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::contentwarehouse::v1::RunPipelineResponse > >

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
name	std::string const & The name of the operation resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::longrunning::Operation >	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.