Class TenantServiceClient (2.27.0)

Version 2.27.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

A service that handles tenant management, including CRUD and enumeration.

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

TenantServiceClient(TenantServiceClient const &)

Copy and move support

Parameter
Name	Description
	TenantServiceClient const &

TenantServiceClient(TenantServiceClient &&)

Copy and move support

Parameter
Name	Description
	TenantServiceClient &&

TenantServiceClient(std::shared_ptr< TenantServiceConnection >, Options)

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

Operators

operator=(TenantServiceClient const &)

Copy and move support

Parameter
Name	Description
	TenantServiceClient const &

Returns
Type	Description
TenantServiceClient &

operator=(TenantServiceClient &&)

Copy and move support

Parameter
Name	Description
	TenantServiceClient &&

Returns
Type	Description
TenantServiceClient &

Functions

CreateTenant(std::string const &, google::cloud::talent::v4::Tenant const &, Options)

Creates a new tenant entity.

Parameters
Name	Description
parent	std::string const & Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo".
tenant	google::cloud::talent::v4::Tenant const & Required. The tenant to be created.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::talent::v4::Tenant >	the result of the RPC. The response message type (google.cloud.talent.v4.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::talent::v4::CreateTenantRequest const &, Options)

Creates a new tenant entity.

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

GetTenant(std::string const &, Options)

Retrieves specified tenant.

Parameters
Name	Description
name	std::string const & Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::talent::v4::Tenant >	the result of the RPC. The response message type (google.cloud.talent.v4.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::talent::v4::GetTenantRequest const &, Options)

Retrieves specified tenant.

Parameters
Name	Description
request	google::cloud::talent::v4::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.talent.v4.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::talent::v4::Tenant >	the result of the RPC. The response message type (google.cloud.talent.v4.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::talent::v4::Tenant const &, google::protobuf::FieldMask const &, Options)

Updates specified tenant.

Parameters
Name	Description
tenant	google::cloud::talent::v4::Tenant const & Required. The tenant resource to replace the current resource in the system.
update_mask	google::protobuf::FieldMask const & Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::talent::v4::Tenant >	the result of the RPC. The response message type (google.cloud.talent.v4.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::talent::v4::UpdateTenantRequest const &, Options)

Updates specified tenant.

Parameters
Name	Description
request	google::cloud::talent::v4::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.talent.v4.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::talent::v4::Tenant >	the result of the RPC. The response message type (google.cloud.talent.v4.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)

Deletes specified tenant.

Parameters
Name	Description
name	std::string const & Required. The resource name of the tenant to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
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::talent::v4::DeleteTenantRequest const &, Options)

Deletes specified tenant.

Parameters
Name	Description
request	google::cloud::talent::v4::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.talent.v4.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.

ListTenants(std::string const &, Options)

Lists all tenants associated with the project.

Parameters
Name	Description
parent	std::string const & Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo".
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::talent::v4::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.talent.v4.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::talent::v4::ListTenantsRequest, Options)

Lists all tenants associated with the project.

Parameters
Name	Description
request	google::cloud::talent::v4::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.talent.v4.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::talent::v4::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.talent.v4.Tenant, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.