Class CloudDeployClient (2.16.0)

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

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

CloudDeployClient(CloudDeployClient const &)

Copy and move support

Parameter
Name	Description
	`CloudDeployClient const &`

CloudDeployClient(CloudDeployClient &&)

Copy and move support

Parameter
Name	Description
	`CloudDeployClient &&`

CloudDeployClient(std::shared_ptr< CloudDeployConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< CloudDeployConnection >`
`opts`	`Options`

Operators

operator=(CloudDeployClient const &)

Copy and move support

Parameter
Name	Description
	`CloudDeployClient const &`

Returns
Type	Description
`CloudDeployClient &`

operator=(CloudDeployClient &&)

Copy and move support

Parameter
Name	Description
	`CloudDeployClient &&`

Returns
Type	Description
`CloudDeployClient &`

Functions

ListDeliveryPipelines(std::string const &, Options)

Lists DeliveryPipelines in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::deploy::v1::DeliveryPipeline >

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

ListDeliveryPipelines(google::cloud::deploy::v1::ListDeliveryPipelinesRequest, Options)

Lists DeliveryPipelines in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::ListDeliveryPipelinesRequest` 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.deploy.v1.ListDeliveryPipelinesRequest. 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::deploy::v1::DeliveryPipeline >

GetDeliveryPipeline(std::string const &, Options)

Gets details of a single DeliveryPipeline.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the `DeliveryPipeline`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetDeliveryPipeline(google::cloud::deploy::v1::GetDeliveryPipelineRequest const &, Options)

Gets details of a single DeliveryPipeline.

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

CreateDeliveryPipeline(std::string const &, google::cloud::deploy::v1::DeliveryPipeline const &, std::string const &, Options)

Creates a new DeliveryPipeline in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent collection in which the `DeliveryPipeline` should be created. Format should be projects/{project_id}/locations/{location_name}.
`delivery_pipeline`	`google::cloud::deploy::v1::DeliveryPipeline const &` Required. The `DeliveryPipeline` to create.
`delivery_pipeline_id`	`std::string const &` Required. ID of the `DeliveryPipeline`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::deploy::v1::DeliveryPipeline > >

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.deploy.v1.DeliveryPipeline proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDeliveryPipeline(google::cloud::deploy::v1::CreateDeliveryPipelineRequest const &, Options)

Creates a new DeliveryPipeline in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::CreateDeliveryPipelineRequest 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.deploy.v1.CreateDeliveryPipelineRequest. 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::deploy::v1::DeliveryPipeline > >

UpdateDeliveryPipeline(google::cloud::deploy::v1::DeliveryPipeline const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single DeliveryPipeline.

Parameters
Name	Description
`delivery_pipeline`	`google::cloud::deploy::v1::DeliveryPipeline const &` Required. The `DeliveryPipeline` to update.
`update_mask`	`google::protobuf::FieldMask const &` Required. Field mask is used to specify the fields to be overwritten in the `DeliveryPipeline` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::deploy::v1::DeliveryPipeline > >

UpdateDeliveryPipeline(google::cloud::deploy::v1::UpdateDeliveryPipelineRequest const &, Options)

Updates the parameters of a single DeliveryPipeline.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::UpdateDeliveryPipelineRequest 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.deploy.v1.UpdateDeliveryPipelineRequest. 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::deploy::v1::DeliveryPipeline > >

DeleteDeliveryPipeline(std::string const &, Options)

Deletes a single DeliveryPipeline.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the `DeliveryPipeline` to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

DeleteDeliveryPipeline(google::cloud::deploy::v1::DeleteDeliveryPipelineRequest const &, Options)

Deletes a single DeliveryPipeline.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::DeleteDeliveryPipelineRequest 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.deploy.v1.DeleteDeliveryPipelineRequest. 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::deploy::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.deploy.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListTargets(std::string const &, Options)

Lists Targets in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::deploy::v1::Target >

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

ListTargets(google::cloud::deploy::v1::ListTargetsRequest, Options)

Lists Targets in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::ListTargetsRequest` 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.deploy.v1.ListTargetsRequest. 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::deploy::v1::Target >

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

GetTarget(std::string const &, Options)

Gets details of a single Target.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the `Target`. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetTarget(google::cloud::deploy::v1::GetTargetRequest const &, Options)

Gets details of a single Target.

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

CreateTarget(std::string const &, google::cloud::deploy::v1::Target const &, std::string const &, Options)

Creates a new Target in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent collection in which the `Target` should be created. Format should be projects/{project_id}/locations/{location_name}.
`target`	`google::cloud::deploy::v1::Target const &` Required. The `Target` to create.
`target_id`	`std::string const &` Required. ID of the `Target`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::deploy::v1::Target > >

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.deploy.v1.Target proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTarget(google::cloud::deploy::v1::CreateTargetRequest const &, Options)

Creates a new Target in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::CreateTargetRequest 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.deploy.v1.CreateTargetRequest. 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::deploy::v1::Target > >

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.deploy.v1.Target proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTarget(google::cloud::deploy::v1::Target const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Target.

Parameters
Name	Description
`target`	`google::cloud::deploy::v1::Target const &` Required. The `Target` to update.
`update_mask`	`google::protobuf::FieldMask const &` Required. Field mask is used to specify the fields to be overwritten in the Target resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::deploy::v1::Target > >

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.deploy.v1.Target proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTarget(google::cloud::deploy::v1::UpdateTargetRequest const &, Options)

Updates the parameters of a single Target.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::UpdateTargetRequest 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.deploy.v1.UpdateTargetRequest. 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::deploy::v1::Target > >

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.deploy.v1.Target proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTarget(std::string const &, Options)

Deletes a single Target.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the `Target` to delete. Format should be projects/{project_id}/locations/{location_name}/targets/{target_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

DeleteTarget(google::cloud::deploy::v1::DeleteTargetRequest const &, Options)

Deletes a single Target.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::DeleteTargetRequest 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.deploy.v1.DeleteTargetRequest. 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::deploy::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.deploy.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListReleases(std::string const &, Options)

Lists Releases in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The `DeliveryPipeline` which owns this collection of `Release` objects.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::deploy::v1::Release >

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

ListReleases(google::cloud::deploy::v1::ListReleasesRequest, Options)

Lists Releases in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::ListReleasesRequest` 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.deploy.v1.ListReleasesRequest. 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::deploy::v1::Release >

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

GetRelease(std::string const &, Options)

Gets details of a single Release.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the `Release`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetRelease(google::cloud::deploy::v1::GetReleaseRequest const &, Options)

Gets details of a single Release.

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

CreateRelease(std::string const &, google::cloud::deploy::v1::Release const &, std::string const &, Options)

Creates a new Release in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent collection in which the `Release` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
`release`	`google::cloud::deploy::v1::Release const &` Required. The `Release` to create.
`release_id`	`std::string const &` Required. ID of the `Release`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::deploy::v1::Release > >

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.deploy.v1.Release proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRelease(google::cloud::deploy::v1::CreateReleaseRequest const &, Options)

Creates a new Release in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::CreateReleaseRequest 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.deploy.v1.CreateReleaseRequest. 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::deploy::v1::Release > >

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.deploy.v1.Release proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AbandonRelease(std::string const &, Options)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

AbandonRelease(google::cloud::deploy::v1::AbandonReleaseRequest const &, Options)

Abandons a Release in the Delivery Pipeline.

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

ApproveRollout(std::string const &, Options)

Approves a Rollout.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

ApproveRollout(google::cloud::deploy::v1::ApproveRolloutRequest const &, Options)

Approves a Rollout.

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

AdvanceRollout(std::string const &, std::string const &, Options)

Advances a Rollout in a given project and location.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
`phase_id`	`std::string const &` Required. The phase ID to advance the `Rollout` to.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

AdvanceRollout(google::cloud::deploy::v1::AdvanceRolloutRequest const &, Options)

Advances a Rollout in a given project and location.

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

CancelRollout(std::string const &, Options)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

CancelRollout(google::cloud::deploy::v1::CancelRolloutRequest const &, Options)

Cancels a Rollout in a given project and location.

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

ListRollouts(std::string const &, Options)

Lists Rollouts in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The `Release` which owns this collection of `Rollout` objects.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::deploy::v1::Rollout >

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

ListRollouts(google::cloud::deploy::v1::ListRolloutsRequest, Options)

Lists Rollouts in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::ListRolloutsRequest` 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.deploy.v1.ListRolloutsRequest. 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::deploy::v1::Rollout >

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

GetRollout(std::string const &, Options)

Gets details of a single Rollout.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the `Rollout`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetRollout(google::cloud::deploy::v1::GetRolloutRequest const &, Options)

Gets details of a single Rollout.

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

CreateRollout(std::string const &, google::cloud::deploy::v1::Rollout const &, std::string const &, Options)

Creates a new Rollout in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent collection in which the `Rollout` should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
`rollout`	`google::cloud::deploy::v1::Rollout const &` Required. The `Rollout` to create.
`rollout_id`	`std::string const &` Required. ID of the `Rollout`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::deploy::v1::Rollout > >

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.deploy.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRollout(google::cloud::deploy::v1::CreateRolloutRequest const &, Options)

Creates a new Rollout in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::CreateRolloutRequest 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.deploy.v1.CreateRolloutRequest. 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::deploy::v1::Rollout > >

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.deploy.v1.Rollout proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

IgnoreJob(std::string const &, std::string const &, std::string const &, Options)

Ignores the specified Job in a Rollout.

Parameters
Name	Description
`rollout`	`std::string const &` Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
`phase_id`	`std::string const &` Required. The phase ID the Job to ignore belongs to.
`job_id`	`std::string const &` Required. The job ID for the Job to ignore.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

IgnoreJob(google::cloud::deploy::v1::IgnoreJobRequest const &, Options)

Ignores the specified Job in a Rollout.

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

RetryJob(std::string const &, std::string const &, std::string const &, Options)

Retries the specified Job in a Rollout.

Parameters
Name	Description
`rollout`	`std::string const &` Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
`phase_id`	`std::string const &` Required. The phase ID the Job to retry belongs to.
`job_id`	`std::string const &` Required. The job ID for the Job to retry.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

RetryJob(google::cloud::deploy::v1::RetryJobRequest const &, Options)

Retries the specified Job in a Rollout.

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

ListJobRuns(std::string const &, Options)

Lists JobRuns in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The `Rollout` which owns this collection of `JobRun` objects.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::deploy::v1::JobRun >

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

ListJobRuns(google::cloud::deploy::v1::ListJobRunsRequest, Options)

Lists JobRuns in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::deploy::v1::ListJobRunsRequest` 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.deploy.v1.ListJobRunsRequest. 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::deploy::v1::JobRun >

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

GetJobRun(std::string const &, Options)

Gets details of a single JobRun.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the `JobRun`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetJobRun(google::cloud::deploy::v1::GetJobRunRequest const &, Options)

Gets details of a single JobRun.

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

TerminateJobRun(std::string const &, Options)

Terminates a Job Run in a given project and location.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the `JobRun`. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

TerminateJobRun(google::cloud::deploy::v1::TerminateJobRunRequest const &, Options)

Terminates a Job Run in a given project and location.

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

GetConfig(std::string const &, Options)

Gets the configuration for a location.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of requested configuration.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetConfig(google::cloud::deploy::v1::GetConfigRequest const &, Options)

Gets the configuration for a location.

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