Class PolicyBindingsClient (2.37.0-rc)

An interface for managing Identity and Access Management (IAM) policy bindings.

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

PolicyBindingsClient(PolicyBindingsClient const &)

Copy and move support

Parameter
Name Description
PolicyBindingsClient const &

PolicyBindingsClient(PolicyBindingsClient &&)

Copy and move support

Parameter
Name Description
PolicyBindingsClient &&

PolicyBindingsClient(std::shared_ptr< PolicyBindingsConnection >, Options)

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

Operators

operator=(PolicyBindingsClient const &)

Copy and move support

Parameter
Name Description
PolicyBindingsClient const &
Returns
Type Description
PolicyBindingsClient &

operator=(PolicyBindingsClient &&)

Copy and move support

Parameter
Name Description
PolicyBindingsClient &&
Returns
Type Description
PolicyBindingsClient &

Functions

CreatePolicyBinding(std::string const &, google::iam::v3::PolicyBinding const &, std::string const &, Options)

Creates a policy binding and returns a long-running operation.

Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target.
Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
policy_binding google::iam::v3::PolicyBinding const &

Required. The policy binding to create.

policy_binding_id std::string const &

Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.
This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

opts Options

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

Returns
Type Description
future< StatusOr< google::iam::v3::PolicyBinding > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.iam.v3.PolicyBinding proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePolicyBinding(NoAwaitTag, std::string const &, google::iam::v3::PolicyBinding const &, std::string const &, Options)

Creates a policy binding and returns a long-running operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
policy_binding google::iam::v3::PolicyBinding const &
policy_binding_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePolicyBinding(google::iam::v3::CreatePolicyBindingRequest const &, Options)

Creates a policy binding and returns a long-running operation.

Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

Parameters
Name Description
request google::iam::v3::CreatePolicyBindingRequest 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.iam.v3.CreatePolicyBindingRequest. 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
future< StatusOr< google::iam::v3::PolicyBinding > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.iam.v3.PolicyBinding proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePolicyBinding(NoAwaitTag, google::iam::v3::CreatePolicyBindingRequest const &, Options)

Creates a policy binding and returns a long-running operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::iam::v3::CreatePolicyBindingRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePolicyBinding(google::longrunning::Operation const &, Options)

Creates a policy binding and returns a long-running operation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::iam::v3::PolicyBinding > >

GetPolicyBinding(std::string const &, Options)

Gets a policy binding.

Parameters
Name Description
name std::string const &

Required. The name of the policy binding to retrieve.
Format:

  • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
  • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
  • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
  • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
opts Options

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

Returns
Type Description
StatusOr< google::iam::v3::PolicyBinding >

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

GetPolicyBinding(google::iam::v3::GetPolicyBindingRequest const &, Options)

Gets a policy binding.

Parameters
Name Description
request google::iam::v3::GetPolicyBindingRequest 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.iam.v3.GetPolicyBindingRequest. 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::iam::v3::PolicyBinding >

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

UpdatePolicyBinding(google::iam::v3::PolicyBinding const &, google::protobuf::FieldMask const &, Options)

Updates a policy binding and returns a long-running operation.

Callers will need the IAM permissions on the policy and target in the binding to update, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.

Parameters
Name Description
policy_binding google::iam::v3::PolicyBinding const &

Required. The policy binding to update.
The policy binding's name field is used to identify the policy binding to update.

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
future< StatusOr< google::iam::v3::PolicyBinding > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.iam.v3.PolicyBinding proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePolicyBinding(NoAwaitTag, google::iam::v3::PolicyBinding const &, google::protobuf::FieldMask const &, Options)

Updates a policy binding and returns a long-running operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
policy_binding google::iam::v3::PolicyBinding const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePolicyBinding(google::iam::v3::UpdatePolicyBindingRequest const &, Options)

Updates a policy binding and returns a long-running operation.

Callers will need the IAM permissions on the policy and target in the binding to update, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.

Parameters
Name Description
request google::iam::v3::UpdatePolicyBindingRequest 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.iam.v3.UpdatePolicyBindingRequest. 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
future< StatusOr< google::iam::v3::PolicyBinding > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.iam.v3.PolicyBinding proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePolicyBinding(NoAwaitTag, google::iam::v3::UpdatePolicyBindingRequest const &, Options)

Updates a policy binding and returns a long-running operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::iam::v3::UpdatePolicyBindingRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePolicyBinding(google::longrunning::Operation const &, Options)

Updates a policy binding and returns a long-running operation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::iam::v3::PolicyBinding > >

DeletePolicyBinding(std::string const &, Options)

Deletes a policy binding and returns a long-running operation.

Callers will need the IAM permissions on both the policy and target. Once the binding is deleted, the policy no longer applies to the target.

Parameters
Name Description
name std::string const &

Required. The name of the policy binding to delete.
Format:

  • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
  • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
  • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
  • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
opts Options

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

Returns
Type Description
future< StatusOr< google::iam::v3::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.iam.v3.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePolicyBinding(NoAwaitTag, std::string const &, Options)

Deletes a policy binding and returns a long-running operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeletePolicyBinding(google::iam::v3::DeletePolicyBindingRequest const &, Options)

Deletes a policy binding and returns a long-running operation.

Callers will need the IAM permissions on both the policy and target. Once the binding is deleted, the policy no longer applies to the target.

Parameters
Name Description
request google::iam::v3::DeletePolicyBindingRequest 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.iam.v3.DeletePolicyBindingRequest. 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
future< StatusOr< google::iam::v3::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.iam.v3.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePolicyBinding(NoAwaitTag, google::iam::v3::DeletePolicyBindingRequest const &, Options)

Deletes a policy binding and returns a long-running operation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::iam::v3::DeletePolicyBindingRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeletePolicyBinding(google::longrunning::Operation const &, Options)

Deletes a policy binding and returns a long-running operation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::iam::v3::OperationMetadata > >

ListPolicyBindings(std::string const &, Options)

Lists policy bindings.

Parameters
Name Description
parent std::string const &

Required. The parent resource, which owns the collection of policy bindings.
Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
opts Options

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

Returns
Type Description
StreamRange< google::iam::v3::PolicyBinding >

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

ListPolicyBindings(google::iam::v3::ListPolicyBindingsRequest, Options)

Lists policy bindings.

Parameters
Name Description
request google::iam::v3::ListPolicyBindingsRequest

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.iam.v3.ListPolicyBindingsRequest. 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::iam::v3::PolicyBinding >

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

SearchTargetPolicyBindings(std::string const &, std::string const &, Options)

Search policy bindings by target.

Returns all policy binding objects bound directly to target.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.
Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
target std::string const &

Required. The target resource, which is bound to the policy in the binding.
Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}
opts Options

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

Returns
Type Description
StreamRange< google::iam::v3::PolicyBinding >

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

SearchTargetPolicyBindings(google::iam::v3::SearchTargetPolicyBindingsRequest, Options)

Search policy bindings by target.

Returns all policy binding objects bound directly to target.

Parameters
Name Description
request google::iam::v3::SearchTargetPolicyBindingsRequest

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.iam.v3.SearchTargetPolicyBindingsRequest. 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::iam::v3::PolicyBinding >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

Returns
Type Description
StatusOr< google::longrunning::Operation >

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >

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