Manages the rollout of SaaS services.
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
SaasRolloutsClient(SaasRolloutsClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SaasRolloutsClient const &
|
SaasRolloutsClient(SaasRolloutsClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SaasRolloutsClient &&
|
SaasRolloutsClient(std::shared_ptr< SaasRolloutsConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< SaasRolloutsConnection >
|
opts |
Options
|
Operators
operator=(SaasRolloutsClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SaasRolloutsClient const &
|
| Returns | |
|---|---|
| Type | Description |
SaasRolloutsClient & |
|
operator=(SaasRolloutsClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SaasRolloutsClient &&
|
| Returns | |
|---|---|
| Type | Description |
SaasRolloutsClient & |
|
Functions
ListRollouts(std::string const &, Options)
Retrieve a collection of rollouts.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent of the rollout. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::saasplatform::saasservicemgmt::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::saasplatform::saasservicemgmt::v1::ListRolloutsRequest, Options)
Retrieve a collection of rollouts.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::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::saasplatform::saasservicemgmt::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)
Retrieve a single rollout.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the resource within a service. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Rollout > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRollout(google::cloud::saasplatform::saasservicemgmt::v1::GetRolloutRequest const &, Options)
Retrieve a single rollout.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::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::saasplatform::saasservicemgmt::v1::Rollout > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRollout(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::Rollout const &, std::string const &, Options)
Create a new rollout.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent of the rollout. |
rollout |
google::cloud::saasplatform::saasservicemgmt::v1::Rollout const &
Required. The desired state for the rollout. |
rollout_id |
std::string const &
Required. The ID value for the new rollout. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Rollout > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRollout(google::cloud::saasplatform::saasservicemgmt::v1::CreateRolloutRequest const &, Options)
Create a new rollout.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::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 |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Rollout > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRollout(google::cloud::saasplatform::saasservicemgmt::v1::Rollout const &, google::protobuf::FieldMask const &, Options)
Update a single rollout.
| Parameters | |
|---|---|
| Name | Description |
rollout |
google::cloud::saasplatform::saasservicemgmt::v1::Rollout const &
Required. The desired state for the rollout. |
update_mask |
google::protobuf::FieldMask const &
Field mask is used to specify the fields to be overwritten in the Rollout resource by the update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Rollout > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRollout(google::cloud::saasplatform::saasservicemgmt::v1::UpdateRolloutRequest const &, Options)
Update a single rollout.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::UpdateRolloutRequest 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::saasplatform::saasservicemgmt::v1::Rollout > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteRollout(std::string const &, Options)
Delete a single rollout.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the resource within a service. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteRollout(google::cloud::saasplatform::saasservicemgmt::v1::DeleteRolloutRequest const &, Options)
Delete a single rollout.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::DeleteRolloutRequest 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 |
Status |
a |
ListRolloutKinds(std::string const &, Options)
Retrieve a collection of rollout kinds.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent of the rollout kind. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRolloutKinds(google::cloud::saasplatform::saasservicemgmt::v1::ListRolloutKindsRequest, Options)
Retrieve a collection of rollout kinds.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::ListRolloutKindsRequest
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::saasplatform::saasservicemgmt::v1::RolloutKind > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetRolloutKind(std::string const &, Options)
Retrieve a single rollout kind.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the resource within a service. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRolloutKind(google::cloud::saasplatform::saasservicemgmt::v1::GetRolloutKindRequest const &, Options)
Retrieve a single rollout kind.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::GetRolloutKindRequest 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::saasplatform::saasservicemgmt::v1::RolloutKind > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRolloutKind(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind const &, std::string const &, Options)
Create a new rollout kind.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent of the rollout kind. |
rollout_kind |
google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind const &
Required. The desired state for the rollout kind. |
rollout_kind_id |
std::string const &
Required. The ID value for the new rollout kind. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRolloutKind(google::cloud::saasplatform::saasservicemgmt::v1::CreateRolloutKindRequest const &, Options)
Create a new rollout kind.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::CreateRolloutKindRequest 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::saasplatform::saasservicemgmt::v1::RolloutKind > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRolloutKind(google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind const &, google::protobuf::FieldMask const &, Options)
Update a single rollout kind.
| Parameters | |
|---|---|
| Name | Description |
rollout_kind |
google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind const &
Required. The desired state for the rollout kind. |
update_mask |
google::protobuf::FieldMask const &
Field mask is used to specify the fields to be overwritten in the RolloutKind resource by the update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::RolloutKind > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRolloutKind(google::cloud::saasplatform::saasservicemgmt::v1::UpdateRolloutKindRequest const &, Options)
Update a single rollout kind.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::UpdateRolloutKindRequest 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::saasplatform::saasservicemgmt::v1::RolloutKind > |
the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteRolloutKind(std::string const &, Options)
Delete a single rollout kind.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the resource within a service. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteRolloutKind(google::cloud::saasplatform::saasservicemgmt::v1::DeleteRolloutKindRequest const &, Options)
Delete a single rollout kind.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::saasplatform::saasservicemgmt::v1::DeleteRolloutKindRequest 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 |
Status |
a |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::ListLocationsRequest
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::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::GetLocationRequest 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::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |