Class SaasDeploymentsClient (3.14.0-rc)

Manages the deployment 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

SaasDeploymentsClient(SaasDeploymentsClient const &)

Copy and move support

Parameter
Name Description
SaasDeploymentsClient const &

SaasDeploymentsClient(SaasDeploymentsClient &&)

Copy and move support

Parameter
Name Description
SaasDeploymentsClient &&

SaasDeploymentsClient(std::shared_ptr< SaasDeploymentsConnection >, Options)

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

Operators

operator=(SaasDeploymentsClient const &)

Copy and move support

Parameter
Name Description
SaasDeploymentsClient const &
Returns
Type Description
SaasDeploymentsClient &

operator=(SaasDeploymentsClient &&)

Copy and move support

Parameter
Name Description
SaasDeploymentsClient &&
Returns
Type Description
SaasDeploymentsClient &

Functions

ListSaas(std::string const &, Options)

Retrieve a collection of saas.

Parameters
Name Description
parent std::string const &

Required. The parent of the saas.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::saasplatform::saasservicemgmt::v1::Saas >

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

ListSaas(google::cloud::saasplatform::saasservicemgmt::v1::ListSaasRequest, Options)

Retrieve a collection of saas.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::ListSaasRequest

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.ListSaasRequest. 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::Saas >

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

GetSaas(std::string const &, Options)

Retrieve a single saas.

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::Saas >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Saas) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSaas(google::cloud::saasplatform::saasservicemgmt::v1::GetSaasRequest const &, Options)

Retrieve a single saas.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::GetSaasRequest 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.GetSaasRequest. 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::Saas >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Saas) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSaas(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::Saas const &, std::string const &, Options)

Create a new saas.

Parameters
Name Description
parent std::string const &

Required. The parent of the saas.

saas google::cloud::saasplatform::saasservicemgmt::v1::Saas const &

Required. The desired state for the saas.

saas_id std::string const &

Required. The ID value for the new saas.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Saas >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Saas) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSaas(google::cloud::saasplatform::saasservicemgmt::v1::CreateSaasRequest const &, Options)

Create a new saas.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::CreateSaasRequest 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.CreateSaasRequest. 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::Saas >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Saas) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSaas(google::cloud::saasplatform::saasservicemgmt::v1::Saas const &, google::protobuf::FieldMask const &, Options)

Update a single saas.

Parameters
Name Description
saas google::cloud::saasplatform::saasservicemgmt::v1::Saas const &

Required. The desired state for the saas.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Saas 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 Saas 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::Saas >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Saas) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSaas(google::cloud::saasplatform::saasservicemgmt::v1::UpdateSaasRequest const &, Options)

Update a single saas.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::UpdateSaasRequest 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.UpdateSaasRequest. 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::Saas >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Saas) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteSaas(std::string const &, Options)

Delete a single saas.

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.

DeleteSaas(google::cloud::saasplatform::saasservicemgmt::v1::DeleteSaasRequest const &, Options)

Delete a single saas.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::DeleteSaasRequest 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.DeleteSaasRequest. 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.

ListTenants(std::string const &, Options)

Retrieve a collection of tenants.

Parameters
Name Description
parent std::string const &

Required. The parent of the tenant.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::saasplatform::saasservicemgmt::v1::Tenant >

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

ListTenants(google::cloud::saasplatform::saasservicemgmt::v1::ListTenantsRequest, Options)

Retrieve a collection of tenants.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::ListTenantsRequest

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.ListTenantsRequest. 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::Tenant >

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

GetTenant(std::string const &, Options)

Retrieve a single tenant.

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::Tenant >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Tenant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTenant(google::cloud::saasplatform::saasservicemgmt::v1::GetTenantRequest const &, Options)

Retrieve a single tenant.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::GetTenantRequest 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.GetTenantRequest. 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::Tenant >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Tenant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTenant(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::Tenant const &, std::string const &, Options)

Create a new tenant.

Parameters
Name Description
parent std::string const &

Required. The parent of the tenant.

tenant google::cloud::saasplatform::saasservicemgmt::v1::Tenant const &

Required. The desired state for the tenant.

tenant_id std::string const &

Required. The ID value for the new tenant.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Tenant >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Tenant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTenant(google::cloud::saasplatform::saasservicemgmt::v1::CreateTenantRequest const &, Options)

Create a new tenant.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::CreateTenantRequest 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.CreateTenantRequest. 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::Tenant >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Tenant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTenant(google::cloud::saasplatform::saasservicemgmt::v1::Tenant const &, google::protobuf::FieldMask const &, Options)

Update a single tenant.

Parameters
Name Description
tenant google::cloud::saasplatform::saasservicemgmt::v1::Tenant const &

Required. The desired state for the tenant.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Tenant 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 Tenant 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::Tenant >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Tenant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTenant(google::cloud::saasplatform::saasservicemgmt::v1::UpdateTenantRequest const &, Options)

Update a single tenant.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::UpdateTenantRequest 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.UpdateTenantRequest. 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::Tenant >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Tenant) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteTenant(std::string const &, Options)

Delete a single tenant.

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.

DeleteTenant(google::cloud::saasplatform::saasservicemgmt::v1::DeleteTenantRequest const &, Options)

Delete a single tenant.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::DeleteTenantRequest 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.DeleteTenantRequest. 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.

ListUnitKinds(std::string const &, Options)

Retrieve a collection of unit kinds.

Parameters
Name Description
parent std::string const &

Required. The parent of the unit kind.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::saasplatform::saasservicemgmt::v1::UnitKind >

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

ListUnitKinds(google::cloud::saasplatform::saasservicemgmt::v1::ListUnitKindsRequest, Options)

Retrieve a collection of unit kinds.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::ListUnitKindsRequest

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.ListUnitKindsRequest. 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::UnitKind >

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

GetUnitKind(std::string const &, Options)

Retrieve a single unit 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::UnitKind >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetUnitKind(google::cloud::saasplatform::saasservicemgmt::v1::GetUnitKindRequest const &, Options)

Retrieve a single unit kind.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::GetUnitKindRequest 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.GetUnitKindRequest. 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::UnitKind >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUnitKind(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::UnitKind const &, std::string const &, Options)

Create a new unit kind.

Parameters
Name Description
parent std::string const &

Required. The parent of the unit kind.

unit_kind google::cloud::saasplatform::saasservicemgmt::v1::UnitKind const &

Required. The desired state for the unit kind.

unit_kind_id std::string const &

Required. The ID value for the new unit kind.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::UnitKind >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUnitKind(google::cloud::saasplatform::saasservicemgmt::v1::CreateUnitKindRequest const &, Options)

Create a new unit kind.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::CreateUnitKindRequest 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.CreateUnitKindRequest. 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::UnitKind >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateUnitKind(google::cloud::saasplatform::saasservicemgmt::v1::UnitKind const &, google::protobuf::FieldMask const &, Options)

Update a single unit kind.

Parameters
Name Description
unit_kind google::cloud::saasplatform::saasservicemgmt::v1::UnitKind const &

Required. The desired state for the unit kind.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the UnitKind 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 UnitKind 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::UnitKind >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateUnitKind(google::cloud::saasplatform::saasservicemgmt::v1::UpdateUnitKindRequest const &, Options)

Update a single unit kind.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::UpdateUnitKindRequest 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.UpdateUnitKindRequest. 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::UnitKind >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitKind) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteUnitKind(std::string const &, Options)

Delete a single unit 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.

DeleteUnitKind(google::cloud::saasplatform::saasservicemgmt::v1::DeleteUnitKindRequest const &, Options)

Delete a single unit kind.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::DeleteUnitKindRequest 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.DeleteUnitKindRequest. 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.

ListUnits(std::string const &, Options)

Retrieve a collection of units.

Parameters
Name Description
parent std::string const &

Required. The parent of the unit.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::saasplatform::saasservicemgmt::v1::Unit >

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

ListUnits(google::cloud::saasplatform::saasservicemgmt::v1::ListUnitsRequest, Options)

Retrieve a collection of units.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::ListUnitsRequest

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.ListUnitsRequest. 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::Unit >

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

GetUnit(std::string const &, Options)

Retrieve a single unit.

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::Unit >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Unit) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetUnit(google::cloud::saasplatform::saasservicemgmt::v1::GetUnitRequest const &, Options)

Retrieve a single unit.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::GetUnitRequest 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.GetUnitRequest. 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::Unit >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Unit) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUnit(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::Unit const &, std::string const &, Options)

Create a new unit.

Parameters
Name Description
parent std::string const &

Required. The parent of the unit.

unit google::cloud::saasplatform::saasservicemgmt::v1::Unit const &

Required. The desired state for the unit.

unit_id std::string const &

Required. The ID value for the new unit.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Unit >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Unit) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUnit(google::cloud::saasplatform::saasservicemgmt::v1::CreateUnitRequest const &, Options)

Create a new unit.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::CreateUnitRequest 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.CreateUnitRequest. 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::Unit >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Unit) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateUnit(google::cloud::saasplatform::saasservicemgmt::v1::Unit const &, google::protobuf::FieldMask const &, Options)

Update a single unit.

Parameters
Name Description
unit google::cloud::saasplatform::saasservicemgmt::v1::Unit const &

Required. The desired state for the unit.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Unit 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 Unit 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::Unit >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Unit) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateUnit(google::cloud::saasplatform::saasservicemgmt::v1::UpdateUnitRequest const &, Options)

Update a single unit.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::UpdateUnitRequest 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.UpdateUnitRequest. 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::Unit >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Unit) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteUnit(std::string const &, Options)

Delete a single unit.

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.

DeleteUnit(google::cloud::saasplatform::saasservicemgmt::v1::DeleteUnitRequest const &, Options)

Delete a single unit.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::DeleteUnitRequest 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.DeleteUnitRequest. 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.

ListUnitOperations(std::string const &, Options)

Retrieve a collection of unit operations.

Parameters
Name Description
parent std::string const &

Required. The parent of the unit operation.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::saasplatform::saasservicemgmt::v1::UnitOperation >

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

ListUnitOperations(google::cloud::saasplatform::saasservicemgmt::v1::ListUnitOperationsRequest, Options)

Retrieve a collection of unit operations.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::ListUnitOperationsRequest

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.ListUnitOperationsRequest. 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::UnitOperation >

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

GetUnitOperation(std::string const &, Options)

Retrieve a single unit operation.

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::UnitOperation >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetUnitOperation(google::cloud::saasplatform::saasservicemgmt::v1::GetUnitOperationRequest const &, Options)

Retrieve a single unit operation.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::GetUnitOperationRequest 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.GetUnitOperationRequest. 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::UnitOperation >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUnitOperation(std::string const &, google::cloud::saasplatform::saasservicemgmt::v1::UnitOperation const &, std::string const &, Options)

Create a new unit operation.

Parameters
Name Description
parent std::string const &

Required. The parent of the unit operation.

unit_operation google::cloud::saasplatform::saasservicemgmt::v1::UnitOperation const &

Required. The desired state for the unit operation.

unit_operation_id std::string const &

Required. The ID value for the new unit operation.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::UnitOperation >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateUnitOperation(google::cloud::saasplatform::saasservicemgmt::v1::CreateUnitOperationRequest const &, Options)

Create a new unit operation.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::CreateUnitOperationRequest 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.CreateUnitOperationRequest. 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::UnitOperation >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateUnitOperation(google::cloud::saasplatform::saasservicemgmt::v1::UnitOperation const &, google::protobuf::FieldMask const &, Options)

Update a single unit operation.

Parameters
Name Description
unit_operation google::cloud::saasplatform::saasservicemgmt::v1::UnitOperation const &

Required. The desired state for the unit operation.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the UnitOperation 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 UnitOperation 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::UnitOperation >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateUnitOperation(google::cloud::saasplatform::saasservicemgmt::v1::UpdateUnitOperationRequest const &, Options)

Update a single unit operation.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::UpdateUnitOperationRequest 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.UpdateUnitOperationRequest. 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::UnitOperation >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteUnitOperation(std::string const &, Options)

Delete a single unit operation.

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.

DeleteUnitOperation(google::cloud::saasplatform::saasservicemgmt::v1::DeleteUnitOperationRequest const &, Options)

Delete a single unit operation.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::DeleteUnitOperationRequest 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.DeleteUnitOperationRequest. 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.

ListReleases(std::string const &, Options)

Retrieve a collection of releases.

Parameters
Name Description
parent std::string const &

Required. The parent of the release.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::saasplatform::saasservicemgmt::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.saasplatform.saasservicemgmt.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::saasplatform::saasservicemgmt::v1::ListReleasesRequest, Options)

Retrieve a collection of releases.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::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.saasplatform.saasservicemgmt.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::saasplatform::saasservicemgmt::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.saasplatform.saasservicemgmt.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)

Retrieve a single release.

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::Release >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.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::saasplatform::saasservicemgmt::v1::GetReleaseRequest const &, Options)

Retrieve a single release.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::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.saasplatform.saasservicemgmt.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::saasplatform::saasservicemgmt::v1::Release >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.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::saasplatform::saasservicemgmt::v1::Release const &, std::string const &, Options)

Create a new release.

Parameters
Name Description
parent std::string const &

Required. The parent of the release.

release google::cloud::saasplatform::saasservicemgmt::v1::Release const &

Required. The desired state for the release.

release_id std::string const &

Required. The ID value for the new release.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Release >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Release) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Create a new release.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::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.saasplatform.saasservicemgmt.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
StatusOr< google::cloud::saasplatform::saasservicemgmt::v1::Release >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Release) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRelease(google::cloud::saasplatform::saasservicemgmt::v1::Release const &, google::protobuf::FieldMask const &, Options)

Update a single release.

Parameters
Name Description
release google::cloud::saasplatform::saasservicemgmt::v1::Release const &

Required. The desired state for the release.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Release 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 Release 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::Release >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Release) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRelease(google::cloud::saasplatform::saasservicemgmt::v1::UpdateReleaseRequest const &, Options)

Update a single release.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::UpdateReleaseRequest 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.UpdateReleaseRequest. 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::Release >

the result of the RPC. The response message type (google.cloud.saasplatform.saasservicemgmt.v1.Release) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteRelease(std::string const &, Options)

Delete a single release.

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.

DeleteRelease(google::cloud::saasplatform::saasservicemgmt::v1::DeleteReleaseRequest const &, Options)

Delete a single release.

Parameters
Name Description
request google::cloud::saasplatform::saasservicemgmt::v1::DeleteReleaseRequest 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.DeleteReleaseRequest. 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.