Class CloudControlsPartnerCoreClient (2.45.0-rc)

Service describing handlers for resources.

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

CloudControlsPartnerCoreClient(CloudControlsPartnerCoreClient const &)

Copy and move support

Parameter
Name Description
CloudControlsPartnerCoreClient const &

CloudControlsPartnerCoreClient(CloudControlsPartnerCoreClient &&)

Copy and move support

Parameter
Name Description
CloudControlsPartnerCoreClient &&

CloudControlsPartnerCoreClient(std::shared_ptr< CloudControlsPartnerCoreConnection >, Options)

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

Operators

operator=(CloudControlsPartnerCoreClient const &)

Copy and move support

Parameter
Name Description
CloudControlsPartnerCoreClient const &
Returns
Type Description
CloudControlsPartnerCoreClient &

operator=(CloudControlsPartnerCoreClient &&)

Copy and move support

Parameter
Name Description
CloudControlsPartnerCoreClient &&
Returns
Type Description
CloudControlsPartnerCoreClient &

Functions

GetWorkload(std::string const &, Options)

Gets details of a single workload.

Parameters
Name Description
name std::string const &

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::Workload >

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

GetWorkload(google::cloud::cloudcontrolspartner::v1::GetWorkloadRequest const &, Options)

Gets details of a single workload.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::GetWorkloadRequest 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.cloudcontrolspartner.v1.GetWorkloadRequest. 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::cloudcontrolspartner::v1::Workload >

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

ListWorkloads(std::string const &, Options)

Lists customer workloads for a given customer org id.

Parameters
Name Description
parent std::string const &

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}
opts Options

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

Returns
Type Description
StreamRange< google::cloud::cloudcontrolspartner::v1::Workload >

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

ListWorkloads(google::cloud::cloudcontrolspartner::v1::ListWorkloadsRequest, Options)

Lists customer workloads for a given customer org id.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::ListWorkloadsRequest

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.cloudcontrolspartner.v1.ListWorkloadsRequest. 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::cloudcontrolspartner::v1::Workload >

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

GetCustomer(std::string const &, Options)

Gets details of a single customer.

Parameters
Name Description
name std::string const &

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::Customer >

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

GetCustomer(google::cloud::cloudcontrolspartner::v1::GetCustomerRequest const &, Options)

Gets details of a single customer.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::GetCustomerRequest 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.cloudcontrolspartner.v1.GetCustomerRequest. 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::cloudcontrolspartner::v1::Customer >

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

ListCustomers(std::string const &, Options)

Lists customers of a partner identified by its Google Cloud organization ID.

Parameters
Name Description
parent std::string const &

Required. Parent resource Format: organizations/{organization}/locations/{location}
opts Options

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

Returns
Type Description
StreamRange< google::cloud::cloudcontrolspartner::v1::Customer >

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

ListCustomers(google::cloud::cloudcontrolspartner::v1::ListCustomersRequest, Options)

Lists customers of a partner identified by its Google Cloud organization ID.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::ListCustomersRequest

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.cloudcontrolspartner.v1.ListCustomersRequest. 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::cloudcontrolspartner::v1::Customer >

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

GetEkmConnections(std::string const &, Options)

Gets the EKM connections associated with a workload.

Parameters
Name Description
name std::string const &

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::EkmConnections >

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

GetEkmConnections(google::cloud::cloudcontrolspartner::v1::GetEkmConnectionsRequest const &, Options)

Gets the EKM connections associated with a workload.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::GetEkmConnectionsRequest 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.cloudcontrolspartner.v1.GetEkmConnectionsRequest. 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::cloudcontrolspartner::v1::EkmConnections >

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

GetPartnerPermissions(std::string const &, Options)

Gets the partner permissions granted for a workload.

Parameters
Name Description
name std::string const &

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::PartnerPermissions >

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

GetPartnerPermissions(google::cloud::cloudcontrolspartner::v1::GetPartnerPermissionsRequest const &, Options)

Gets the partner permissions granted for a workload.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::GetPartnerPermissionsRequest 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.cloudcontrolspartner.v1.GetPartnerPermissionsRequest. 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::cloudcontrolspartner::v1::PartnerPermissions >

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

ListAccessApprovalRequests(std::string const &, Options)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
parent std::string const &

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
opts Options

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

Returns
Type Description
StreamRange< google::cloud::cloudcontrolspartner::v1::AccessApprovalRequest >

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

ListAccessApprovalRequests(google::cloud::cloudcontrolspartner::v1::ListAccessApprovalRequestsRequest, Options)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::ListAccessApprovalRequestsRequest

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.cloudcontrolspartner.v1.ListAccessApprovalRequestsRequest. 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::cloudcontrolspartner::v1::AccessApprovalRequest >

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

GetPartner(std::string const &, Options)

Get details of a Partner.

Parameters
Name Description
name std::string const &

Required. Format: organizations/{organization}/locations/{location}/partner
opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::Partner >

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

GetPartner(google::cloud::cloudcontrolspartner::v1::GetPartnerRequest const &, Options)

Get details of a Partner.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::GetPartnerRequest 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.cloudcontrolspartner.v1.GetPartnerRequest. 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::cloudcontrolspartner::v1::Partner >

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

CreateCustomer(std::string const &, google::cloud::cloudcontrolspartner::v1::Customer const &, std::string const &, Options)

Creates a new customer.

Parameters
Name Description
parent std::string const &

Required. Parent resource Format: organizations/{organization}/locations/{location}
customer google::cloud::cloudcontrolspartner::v1::Customer const &

Required. The customer to create.

customer_id std::string const &

Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::Customer >

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

CreateCustomer(google::cloud::cloudcontrolspartner::v1::CreateCustomerRequest const &, Options)

Creates a new customer.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::CreateCustomerRequest 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.cloudcontrolspartner.v1.CreateCustomerRequest. 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::cloudcontrolspartner::v1::Customer >

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

UpdateCustomer(google::cloud::cloudcontrolspartner::v1::Customer const &, google::protobuf::FieldMask const &, Options)

Update details of a single customer.

Parameters
Name Description
customer google::cloud::cloudcontrolspartner::v1::Customer const &

Required. The customer to update Format: organizations/{organization}/locations/{location}/customers/{customer}
update_mask google::protobuf::FieldMask const &

Optional. The list of fields to update

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cloudcontrolspartner::v1::Customer >

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

UpdateCustomer(google::cloud::cloudcontrolspartner::v1::UpdateCustomerRequest const &, Options)

Update details of a single customer.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::UpdateCustomerRequest 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.cloudcontrolspartner.v1.UpdateCustomerRequest. 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::cloudcontrolspartner::v1::Customer >

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

DeleteCustomer(std::string const &, Options)

Delete details of a single customer.

Parameters
Name Description
name std::string const &

Required. name of the resource to be deleted format: name=organizations//locations//customers/*

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.

DeleteCustomer(google::cloud::cloudcontrolspartner::v1::DeleteCustomerRequest const &, Options)

Delete details of a single customer.

Parameters
Name Description
request google::cloud::cloudcontrolspartner::v1::DeleteCustomerRequest 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.cloudcontrolspartner.v1.DeleteCustomerRequest. 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.