Class PrincipalAccessBoundaryPoliciesClient (2.37.0-rc)

Manages Identity and Access Management (IAM) principal access boundary policies.

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

PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesClient const &)

Copy and move support

Parameter
Name Description
PrincipalAccessBoundaryPoliciesClient const &

PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesClient &&)

Copy and move support

Parameter
Name Description
PrincipalAccessBoundaryPoliciesClient &&

PrincipalAccessBoundaryPoliciesClient(std::shared_ptr< PrincipalAccessBoundaryPoliciesConnection >, Options)

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

Operators

operator=(PrincipalAccessBoundaryPoliciesClient const &)

Copy and move support

Parameter
Name Description
PrincipalAccessBoundaryPoliciesClient const &
Returns
Type Description
PrincipalAccessBoundaryPoliciesClient &

operator=(PrincipalAccessBoundaryPoliciesClient &&)

Copy and move support

Parameter
Name Description
PrincipalAccessBoundaryPoliciesClient &&
Returns
Type Description
PrincipalAccessBoundaryPoliciesClient &

Functions

CreatePrincipalAccessBoundaryPolicy(std::string const &, google::iam::v3::PrincipalAccessBoundaryPolicy const &, std::string const &, Options)

Creates a principal access boundary policy, and returns a long running operation.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.
Format: organizations/{organization_id}/locations/{location}
principal_access_boundary_policy google::iam::v3::PrincipalAccessBoundaryPolicy const &

Required. The principal access boundary policy to create.

principal_access_boundary_policy_id std::string const &

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy'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::PrincipalAccessBoundaryPolicy > >

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.PrincipalAccessBoundaryPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePrincipalAccessBoundaryPolicy(NoAwaitTag, std::string const &, google::iam::v3::PrincipalAccessBoundaryPolicy const &, std::string const &, Options)

Creates a principal access boundary policy, 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 &
principal_access_boundary_policy google::iam::v3::PrincipalAccessBoundaryPolicy const &
principal_access_boundary_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePrincipalAccessBoundaryPolicy(google::iam::v3::CreatePrincipalAccessBoundaryPolicyRequest const &, Options)

Creates a principal access boundary policy, and returns a long running operation.

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

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.PrincipalAccessBoundaryPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePrincipalAccessBoundaryPolicy(NoAwaitTag, google::iam::v3::CreatePrincipalAccessBoundaryPolicyRequest const &, Options)

Creates a principal access boundary policy, 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::CreatePrincipalAccessBoundaryPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a principal access boundary policy, 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::PrincipalAccessBoundaryPolicy > >

GetPrincipalAccessBoundaryPolicy(std::string const &, Options)

Gets a principal access boundary policy.

Parameters
Name Description
name std::string const &

Required. The name of the principal access boundary policy to retrieve.
Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}
opts Options

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

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

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

GetPrincipalAccessBoundaryPolicy(google::iam::v3::GetPrincipalAccessBoundaryPolicyRequest const &, Options)

Gets a principal access boundary policy.

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

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

UpdatePrincipalAccessBoundaryPolicy(google::iam::v3::PrincipalAccessBoundaryPolicy const &, google::protobuf::FieldMask const &, Options)

Updates a principal access boundary policy.

Parameters
Name Description
principal_access_boundary_policy google::iam::v3::PrincipalAccessBoundaryPolicy const &

Required. The principal access boundary policy to update.
The principal access boundary policy's name field is used to identify the policy 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::PrincipalAccessBoundaryPolicy > >

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.PrincipalAccessBoundaryPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePrincipalAccessBoundaryPolicy(NoAwaitTag, google::iam::v3::PrincipalAccessBoundaryPolicy const &, google::protobuf::FieldMask const &, Options)

Updates a principal access boundary policy.

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
principal_access_boundary_policy google::iam::v3::PrincipalAccessBoundaryPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePrincipalAccessBoundaryPolicy(google::iam::v3::UpdatePrincipalAccessBoundaryPolicyRequest const &, Options)

Updates a principal access boundary policy.

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

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.PrincipalAccessBoundaryPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePrincipalAccessBoundaryPolicy(NoAwaitTag, google::iam::v3::UpdatePrincipalAccessBoundaryPolicyRequest const &, Options)

Updates a principal access boundary policy.

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::UpdatePrincipalAccessBoundaryPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates a principal access boundary policy.

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

DeletePrincipalAccessBoundaryPolicy(std::string const &, Options)

Deletes a principal access boundary policy.

Parameters
Name Description
name std::string const &

Required. The name of the principal access boundary policy to delete.
Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_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.

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

Deletes a principal access boundary policy.

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 >

DeletePrincipalAccessBoundaryPolicy(google::iam::v3::DeletePrincipalAccessBoundaryPolicyRequest const &, Options)

Deletes a principal access boundary policy.

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

DeletePrincipalAccessBoundaryPolicy(NoAwaitTag, google::iam::v3::DeletePrincipalAccessBoundaryPolicyRequest const &, Options)

Deletes a principal access boundary policy.

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::DeletePrincipalAccessBoundaryPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a principal access boundary policy.

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

ListPrincipalAccessBoundaryPolicies(std::string const &, Options)

Lists principal access boundary policies.

Parameters
Name Description
parent std::string const &

Required. The parent resource, which owns the collection of principal access boundary policies.
Format: 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::PrincipalAccessBoundaryPolicy >

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

ListPrincipalAccessBoundaryPolicies(google::iam::v3::ListPrincipalAccessBoundaryPoliciesRequest, Options)

Lists principal access boundary policies.

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

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.ListPrincipalAccessBoundaryPoliciesRequest. 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::PrincipalAccessBoundaryPolicy >

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

SearchPrincipalAccessBoundaryPolicyBindings(std::string const &, Options)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Parameters
Name Description
name std::string const &

Required. The name of the principal access boundary policy. Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_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.

SearchPrincipalAccessBoundaryPolicyBindings(google::iam::v3::SearchPrincipalAccessBoundaryPolicyBindingsRequest, Options)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

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

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.SearchPrincipalAccessBoundaryPolicyBindingsRequest. 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.