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 |
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 |
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 |
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 |
GetDeliveryPipeline(std::string const &, Options)
Gets details of a single DeliveryPipeline.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
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 |
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 |
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 |
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 |
delivery_pipeline |
google::cloud::deploy::v1::DeliveryPipeline const &
Required. The |
delivery_pipeline_id |
std::string const &
Required. ID of the |
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 |
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 |
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 |
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 |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the |
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 |
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 |
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 |
DeleteDeliveryPipeline(std::string const &, Options)
Deletes a single DeliveryPipeline.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
RollbackTarget(std::string const &, std::string const &, std::string const &, Options)
Creates a Rollout
to roll back the specified target.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The |
target_id |
std::string const &
Required. ID of the |
rollout_id |
std::string const &
Required. ID of the rollback |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::RollbackTargetResponse > | the result of the RPC. The response message type (google.cloud.deploy.v1.RollbackTargetResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RollbackTarget(google::cloud::deploy::v1::RollbackTargetRequest const &, Options)
Creates a Rollout
to roll back the specified target.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::RollbackTargetRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::RollbackTargetResponse > | the result of the RPC. The response message type (google.cloud.deploy.v1.RollbackTargetResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTarget(std::string const &, Options)
Gets details of a single Target.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
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 |
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 |
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 |
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 |
google::cloud::deploy::v1::Target const &
Required. The |
target_id |
std::string const &
Required. ID of the |
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 |
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 |
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 |
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 |
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's in the mask. If the user doesn't provide a mask then all fields are 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 |
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 |
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 |
DeleteTarget(std::string const &, Options)
Deletes a single Target.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the |
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 |
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 |
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 |
ListCustomTargetTypes(std::string const &, Options)
Lists CustomTargetTypes in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent that owns this collection of custom target types. Format must be |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::deploy::v1::CustomTargetType > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCustomTargetTypes(google::cloud::deploy::v1::ListCustomTargetTypesRequest, Options)
Lists CustomTargetTypes in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::ListCustomTargetTypesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::deploy::v1::CustomTargetType > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetCustomTargetType(std::string const &, Options)
Gets details of a single CustomTargetType.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::CustomTargetType > | the result of the RPC. The response message type (google.cloud.deploy.v1.CustomTargetType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCustomTargetType(google::cloud::deploy::v1::GetCustomTargetTypeRequest const &, Options)
Gets details of a single CustomTargetType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::GetCustomTargetTypeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::CustomTargetType > | the result of the RPC. The response message type (google.cloud.deploy.v1.CustomTargetType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCustomTargetType(std::string const &, google::cloud::deploy::v1::CustomTargetType const &, std::string const &, Options)
Creates a new CustomTargetType in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection in which the |
custom_target_type |
google::cloud::deploy::v1::CustomTargetType const &
Required. The |
custom_target_type_id |
std::string const &
Required. ID of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::CustomTargetType > > | A |
CreateCustomTargetType(google::cloud::deploy::v1::CreateCustomTargetTypeRequest const &, Options)
Creates a new CustomTargetType in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::CreateCustomTargetTypeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::CustomTargetType > > | A |
UpdateCustomTargetType(google::cloud::deploy::v1::CustomTargetType const &, google::protobuf::FieldMask const &, Options)
Updates a single CustomTargetType.
Parameters | |
---|---|
Name | Description |
custom_target_type |
google::cloud::deploy::v1::CustomTargetType const &
Required. The |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::CustomTargetType > > | A |
UpdateCustomTargetType(google::cloud::deploy::v1::UpdateCustomTargetTypeRequest const &, Options)
Updates a single CustomTargetType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::UpdateCustomTargetTypeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::CustomTargetType > > | A |
DeleteCustomTargetType(std::string const &, Options)
Deletes a single CustomTargetType.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the |
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 |
DeleteCustomTargetType(google::cloud::deploy::v1::DeleteCustomTargetTypeRequest const &, Options)
Deletes a single CustomTargetType.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::DeleteCustomTargetTypeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
ListReleases(std::string const &, Options)
Lists Releases in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The |
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 |
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 |
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 |
GetRelease(std::string const &, Options)
Gets details of a single Release.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
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 |
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 |
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 |
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 |
google::cloud::deploy::v1::Release const &
Required. The |
release_id |
std::string const &
Required. ID of the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
ApproveRollout(std::string const &, Options)
Approves a Rollout.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the Rollout. Format is |
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 |
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 |
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 |
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 |
phase_id |
std::string const &
Required. The phase ID to advance the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
ListRollouts(std::string const &, Options)
Lists Rollouts in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The |
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 |
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 |
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 |
GetRollout(std::string const &, Options)
Gets details of a single Rollout.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
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 |
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 |
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 |
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 |
google::cloud::deploy::v1::Rollout const &
Required. The |
rollout_id |
std::string const &
Required. ID of the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
ListJobRuns(std::string const &, Options)
Lists JobRuns in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The |
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 |
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 |
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 |
GetJobRun(std::string const &, Options)
Gets details of a single JobRun.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateAutomation(std::string const &, google::cloud::deploy::v1::Automation const &, std::string const &, Options)
Creates a new Automation in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent collection in which the |
automation |
google::cloud::deploy::v1::Automation const &
Required. The |
automation_id |
std::string const &
Required. ID of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::Automation > > | A |
CreateAutomation(google::cloud::deploy::v1::CreateAutomationRequest const &, Options)
Creates a new Automation in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::CreateAutomationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::Automation > > | A |
UpdateAutomation(google::cloud::deploy::v1::Automation const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Automation resource.
Parameters | |
---|---|
Name | Description |
automation |
google::cloud::deploy::v1::Automation const &
Required. The |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::Automation > > | A |
UpdateAutomation(google::cloud::deploy::v1::UpdateAutomationRequest const &, Options)
Updates the parameters of a single Automation resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::UpdateAutomationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::deploy::v1::Automation > > | A |
DeleteAutomation(std::string const &, Options)
Deletes a single Automation resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the |
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 |
DeleteAutomation(google::cloud::deploy::v1::DeleteAutomationRequest const &, Options)
Deletes a single Automation resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::DeleteAutomationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
GetAutomation(std::string const &, Options)
Gets details of a single Automation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::Automation > | the result of the RPC. The response message type (google.cloud.deploy.v1.Automation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAutomation(google::cloud::deploy::v1::GetAutomationRequest const &, Options)
Gets details of a single Automation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::GetAutomationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::Automation > | the result of the RPC. The response message type (google.cloud.deploy.v1.Automation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAutomations(std::string const &, Options)
Lists Automations in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::deploy::v1::Automation > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAutomations(google::cloud::deploy::v1::ListAutomationsRequest, Options)
Lists Automations in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::ListAutomationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::deploy::v1::Automation > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetAutomationRun(std::string const &, Options)
Gets details of a single AutomationRun.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::AutomationRun > | the result of the RPC. The response message type (google.cloud.deploy.v1.AutomationRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAutomationRun(google::cloud::deploy::v1::GetAutomationRunRequest const &, Options)
Gets details of a single AutomationRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::GetAutomationRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::AutomationRun > | the result of the RPC. The response message type (google.cloud.deploy.v1.AutomationRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAutomationRuns(std::string const &, Options)
Lists AutomationRuns in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::deploy::v1::AutomationRun > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAutomationRuns(google::cloud::deploy::v1::ListAutomationRunsRequest, Options)
Lists AutomationRuns in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::ListAutomationRunsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::deploy::v1::AutomationRun > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CancelAutomationRun(std::string const &, Options)
Cancels an AutomationRun.
The state
of the AutomationRun
after cancelling is CANCELLED
. CancelAutomationRun
can be called on AutomationRun in the state IN_PROGRESS
and PENDING
; AutomationRun in a different state returns an FAILED_PRECONDITION
error.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::CancelAutomationRunResponse > | the result of the RPC. The response message type (google.cloud.deploy.v1.CancelAutomationRunResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CancelAutomationRun(google::cloud::deploy::v1::CancelAutomationRunRequest const &, Options)
Cancels an AutomationRun.
The state
of the AutomationRun
after cancelling is CANCELLED
. CancelAutomationRun
can be called on AutomationRun in the state IN_PROGRESS
and PENDING
; AutomationRun in a different state returns an FAILED_PRECONDITION
error.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::deploy::v1::CancelAutomationRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::deploy::v1::CancelAutomationRunResponse > | the result of the RPC. The response message type (google.cloud.deploy.v1.CancelAutomationRunResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |