Class SaasRolloutsClient (3.15.0-rc)

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 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.saasplatform.saasservicemgmt.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::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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.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::saasplatform::saasservicemgmt::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.saasplatform.saasservicemgmt.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)

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.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::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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.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
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 StatusOr contains the error details.

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.
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 in the Rollout will be overwritten.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.UpdateRolloutRequest. 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::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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.DeleteRolloutRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.ListRolloutKindsRequest. 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::saasplatform::saasservicemgmt::v1::RolloutKind >

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

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.GetRolloutKindRequest. 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::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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.CreateRolloutKindRequest. 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::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 StatusOr contains the error details.

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.
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 in the RolloutKind will be overwritten.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.UpdateRolloutKindRequest. 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::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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.saasplatform.saasservicemgmt.v1.DeleteRolloutKindRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. 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::location::Location >

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. 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::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 StatusOr contains the error details.