Class AccessContextManagerClient (2.11.0)

API for setting [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for Google Cloud projects.

Each organization has one [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] that contains the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter]. This [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is applicable to all resources in the organization. AccessPolicies

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

AccessContextManagerClient(AccessContextManagerClient const &)

Copy and move support

Parameter
Name Description
AccessContextManagerClient const &

AccessContextManagerClient(AccessContextManagerClient &&)

Copy and move support

Parameter
Name Description
AccessContextManagerClient &&

AccessContextManagerClient(std::shared_ptr< AccessContextManagerConnection >, Options)

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

Operators

operator=(AccessContextManagerClient const &)

Copy and move support

Parameter
Name Description
AccessContextManagerClient const &
Returns
Type Description
AccessContextManagerClient &

operator=(AccessContextManagerClient &&)

Copy and move support

Parameter
Name Description
AccessContextManagerClient &&
Returns
Type Description
AccessContextManagerClient &

Functions

ListAccessPolicies(google::identity::accesscontextmanager::v1::ListAccessPoliciesRequest, Options)

Lists all [access policies] google.identity.accesscontextmanager.v1.AccessPolicy in an organization.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::ListAccessPoliciesRequest

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.identity.accesscontextmanager.v1.ListAccessPoliciesRequest. 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::identity::accesscontextmanager::v1::AccessPolicy >

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

GetAccessPolicy(std::string const &, Options)

Returns an [access policy] google.identity.accesscontextmanager.v1.AccessPolicy based on the name.

Parameters
Name Description
name std::string const &

Required. Resource name for the access policy to get.
Format accessPolicies/{policy_id}
opts Options

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

Returns
Type Description
StatusOr< google::identity::accesscontextmanager::v1::AccessPolicy >

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

GetAccessPolicy(google::identity::accesscontextmanager::v1::GetAccessPolicyRequest const &, Options)

Returns an [access policy] google.identity.accesscontextmanager.v1.AccessPolicy based on the name.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::GetAccessPolicyRequest 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.identity.accesscontextmanager.v1.GetAccessPolicyRequest. 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::identity::accesscontextmanager::v1::AccessPolicy >

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

CreateAccessPolicy(google::identity::accesscontextmanager::v1::AccessPolicy const &, Options)

Creates an access policy.

This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in metadata as a BadRequest proto.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::AccessPolicy 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.identity.accesscontextmanager.v1.AccessPolicy. 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::identity::accesscontextmanager::v1::AccessPolicy > >

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

UpdateAccessPolicy(google::identity::accesscontextmanager::v1::AccessPolicy const &, google::protobuf::FieldMask const &, Options)

Updates an [access policy] google.identity.accesscontextmanager.v1.AccessPolicy.

The long-running operation from this RPC has a successful status after the changes to the [access policy] google.identity.accesscontextmanager.v1.AccessPolicy propagate to long-lasting storage.

Parameters
Name Description
policy google::identity::accesscontextmanager::v1::AccessPolicy const &

Required. The updated AccessPolicy.

update_mask google::protobuf::FieldMask const &

Required. Mask to control which fields get updated. Must be non-empty.

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::AccessPolicy > >

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

UpdateAccessPolicy(google::identity::accesscontextmanager::v1::UpdateAccessPolicyRequest const &, Options)

Updates an [access policy] google.identity.accesscontextmanager.v1.AccessPolicy.

The long-running operation from this RPC has a successful status after the changes to the [access policy] google.identity.accesscontextmanager.v1.AccessPolicy propagate to long-lasting storage.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::UpdateAccessPolicyRequest 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.identity.accesscontextmanager.v1.UpdateAccessPolicyRequest. 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::identity::accesscontextmanager::v1::AccessPolicy > >

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

DeleteAccessPolicy(std::string const &, Options)

Deletes an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the resource name.

The long-running operation has a successful status after the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is removed from long-lasting storage.

Parameters
Name Description
name std::string const &

Required. Resource name for the access policy to delete.
Format accessPolicies/{policy_id}
opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::AccessContextManagerOperationMetadata > >

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

DeleteAccessPolicy(google::identity::accesscontextmanager::v1::DeleteAccessPolicyRequest const &, Options)

Deletes an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] based on the resource name.

The long-running operation has a successful status after the [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is removed from long-lasting storage.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::DeleteAccessPolicyRequest 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.identity.accesscontextmanager.v1.DeleteAccessPolicyRequest. 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::identity::accesscontextmanager::v1::AccessContextManagerOperationMetadata > >

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

ListAccessLevels(std::string const &, Options)

Lists all [access levels] google.identity.accesscontextmanager.v1.AccessLevel for an access policy.

Parameters
Name Description
parent std::string const &

Required. Resource name for the access policy to list [Access Levels] google.identity.accesscontextmanager.v1.AccessLevel from.
Format: accessPolicies/{policy_id}
opts Options

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

Returns
Type Description
StreamRange< google::identity::accesscontextmanager::v1::AccessLevel >

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

ListAccessLevels(google::identity::accesscontextmanager::v1::ListAccessLevelsRequest, Options)

Lists all [access levels] google.identity.accesscontextmanager.v1.AccessLevel for an access policy.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::ListAccessLevelsRequest

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.identity.accesscontextmanager.v1.ListAccessLevelsRequest. 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::identity::accesscontextmanager::v1::AccessLevel >

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

GetAccessLevel(std::string const &, Options)

Gets an [access level] google.identity.accesscontextmanager.v1.AccessLevel based on the resource name.

Parameters
Name Description
name std::string const &

Required. Resource name for the [Access Level] google.identity.accesscontextmanager.v1.AccessLevel.
Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}
opts Options

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

Returns
Type Description
StatusOr< google::identity::accesscontextmanager::v1::AccessLevel >

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

GetAccessLevel(google::identity::accesscontextmanager::v1::GetAccessLevelRequest const &, Options)

Gets an [access level] google.identity.accesscontextmanager.v1.AccessLevel based on the resource name.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::GetAccessLevelRequest 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.identity.accesscontextmanager.v1.GetAccessLevelRequest. 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::identity::accesscontextmanager::v1::AccessLevel >

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

CreateAccessLevel(std::string const &, google::identity::accesscontextmanager::v1::AccessLevel const &, Options)

Creates an [access level] google.identity.accesscontextmanager.v1.AccessLevel.

The long-running operation from this RPC has a successful status after the [access level] google.identity.accesscontextmanager.v1.AccessLevel propagates to long-lasting storage. If [access levels] google.identity.accesscontextmanager.v1.AccessLevel contain errors, an error response is returned for the first error encountered.

Parameters
Name Description
parent std::string const &

Required. Resource name for the access policy which owns this [Access Level] google.identity.accesscontextmanager.v1.AccessLevel.
Format: accessPolicies/{policy_id}
access_level google::identity::accesscontextmanager::v1::AccessLevel const &

Required. The [Access Level] google.identity.accesscontextmanager.v1.AccessLevel to create. Syntactic correctness of the [Access Level] google.identity.accesscontextmanager.v1.AccessLevel is a precondition for creation.

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::AccessLevel > >

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

CreateAccessLevel(google::identity::accesscontextmanager::v1::CreateAccessLevelRequest const &, Options)

Creates an [access level] google.identity.accesscontextmanager.v1.AccessLevel.

The long-running operation from this RPC has a successful status after the [access level] google.identity.accesscontextmanager.v1.AccessLevel propagates to long-lasting storage. If [access levels] google.identity.accesscontextmanager.v1.AccessLevel contain errors, an error response is returned for the first error encountered.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::CreateAccessLevelRequest 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.identity.accesscontextmanager.v1.CreateAccessLevelRequest. 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::identity::accesscontextmanager::v1::AccessLevel > >

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

UpdateAccessLevel(google::identity::accesscontextmanager::v1::AccessLevel const &, google::protobuf::FieldMask const &, Options)

Updates an [access level] google.identity.accesscontextmanager.v1.AccessLevel.

The long-running operation from this RPC has a successful status after the changes to the [access level] google.identity.accesscontextmanager.v1.AccessLevel propagate to long-lasting storage. If [access levels] google.identity.accesscontextmanager.v1.AccessLevel contain errors, an error response is returned for the first error encountered.

Parameters
Name Description
access_level google::identity::accesscontextmanager::v1::AccessLevel const &

Required. The updated [Access Level] google.identity.accesscontextmanager.v1.AccessLevel. Syntactic correctness of the [Access Level] google.identity.accesscontextmanager.v1.AccessLevel is a precondition for creation.

update_mask google::protobuf::FieldMask const &

Required. Mask to control which fields get updated. Must be non-empty.

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::AccessLevel > >

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

UpdateAccessLevel(google::identity::accesscontextmanager::v1::UpdateAccessLevelRequest const &, Options)

Updates an [access level] google.identity.accesscontextmanager.v1.AccessLevel.

The long-running operation from this RPC has a successful status after the changes to the [access level] google.identity.accesscontextmanager.v1.AccessLevel propagate to long-lasting storage. If [access levels] google.identity.accesscontextmanager.v1.AccessLevel contain errors, an error response is returned for the first error encountered.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::UpdateAccessLevelRequest 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.identity.accesscontextmanager.v1.UpdateAccessLevelRequest. 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::identity::accesscontextmanager::v1::AccessLevel > >

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

DeleteAccessLevel(std::string const &, Options)

Deletes an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name.

The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] has been removed from long-lasting storage.

Parameters
Name Description
name std::string const &

Required. Resource name for the [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].
Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}
opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::AccessContextManagerOperationMetadata > >

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

DeleteAccessLevel(google::identity::accesscontextmanager::v1::DeleteAccessLevelRequest const &, Options)

Deletes an [access level] [google.identity.accesscontextmanager.v1.AccessLevel] based on the resource name.

The long-running operation from this RPC has a successful status after the [access level] [google.identity.accesscontextmanager.v1.AccessLevel] has been removed from long-lasting storage.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::DeleteAccessLevelRequest 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.identity.accesscontextmanager.v1.DeleteAccessLevelRequest. 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::identity::accesscontextmanager::v1::AccessContextManagerOperationMetadata > >

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

ReplaceAccessLevels(google::identity::accesscontextmanager::v1::ReplaceAccessLevelsRequest const &, Options)

Replaces all existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] provided.

This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] contained in existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] result in an error.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::ReplaceAccessLevelsRequest 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.identity.accesscontextmanager.v1.ReplaceAccessLevelsRequest. 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::identity::accesscontextmanager::v1::ReplaceAccessLevelsResponse > >

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

ListServicePerimeters(std::string const &, Options)

Lists all [service perimeters] google.identity.accesscontextmanager.v1.ServicePerimeter for an access policy.

Parameters
Name Description
parent std::string const &

Required. Resource name for the access policy to list [Service Perimeters] google.identity.accesscontextmanager.v1.ServicePerimeter from.
Format: accessPolicies/{policy_id}
opts Options

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

Returns
Type Description
StreamRange< google::identity::accesscontextmanager::v1::ServicePerimeter >

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

ListServicePerimeters(google::identity::accesscontextmanager::v1::ListServicePerimetersRequest, Options)

Lists all [service perimeters] google.identity.accesscontextmanager.v1.ServicePerimeter for an access policy.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::ListServicePerimetersRequest

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.identity.accesscontextmanager.v1.ListServicePerimetersRequest. 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::identity::accesscontextmanager::v1::ServicePerimeter >

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

GetServicePerimeter(std::string const &, Options)

Gets a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter based on the resource name.

Parameters
Name Description
name std::string const &

Required. Resource name for the [Service Perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter.
Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}
opts Options

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

Returns
Type Description
StatusOr< google::identity::accesscontextmanager::v1::ServicePerimeter >

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

GetServicePerimeter(google::identity::accesscontextmanager::v1::GetServicePerimeterRequest const &, Options)

Gets a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter based on the resource name.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::GetServicePerimeterRequest 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.identity.accesscontextmanager.v1.GetServicePerimeterRequest. 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::identity::accesscontextmanager::v1::ServicePerimeter >

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

CreateServicePerimeter(std::string const &, google::identity::accesscontextmanager::v1::ServicePerimeter const &, Options)

Creates a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter.

The long-running operation from this RPC has a successful status after the [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter propagates to long-lasting storage. If a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter contains errors, an error response is returned for the first error encountered.

Parameters
Name Description
parent std::string const &

Required. Resource name for the access policy which owns this [Service Perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter.
Format: accessPolicies/{policy_id}
service_perimeter google::identity::accesscontextmanager::v1::ServicePerimeter const &

Required. The [Service Perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter to create. Syntactic correctness of the [Service Perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter is a precondition for creation.

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::ServicePerimeter > >

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

CreateServicePerimeter(google::identity::accesscontextmanager::v1::CreateServicePerimeterRequest const &, Options)

Creates a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter.

The long-running operation from this RPC has a successful status after the [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter propagates to long-lasting storage. If a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter contains errors, an error response is returned for the first error encountered.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::CreateServicePerimeterRequest 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.identity.accesscontextmanager.v1.CreateServicePerimeterRequest. 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::identity::accesscontextmanager::v1::ServicePerimeter > >

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

UpdateServicePerimeter(google::identity::accesscontextmanager::v1::ServicePerimeter const &, google::protobuf::FieldMask const &, Options)

Updates a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter.

The long-running operation from this RPC has a successful status after the [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter propagates to long-lasting storage. If a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter contains errors, an error response is returned for the first error encountered.

Parameters
Name Description
service_perimeter google::identity::accesscontextmanager::v1::ServicePerimeter const &

Required. The updated ServicePerimeter. Syntactic correctness of the ServicePerimeter is a precondition for creation.

update_mask google::protobuf::FieldMask const &

Required. Mask to control which fields get updated. Must be non-empty.

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::ServicePerimeter > >

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

UpdateServicePerimeter(google::identity::accesscontextmanager::v1::UpdateServicePerimeterRequest const &, Options)

Updates a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter.

The long-running operation from this RPC has a successful status after the [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter propagates to long-lasting storage. If a [service perimeter] google.identity.accesscontextmanager.v1.ServicePerimeter contains errors, an error response is returned for the first error encountered.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::UpdateServicePerimeterRequest 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.identity.accesscontextmanager.v1.UpdateServicePerimeterRequest. 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::identity::accesscontextmanager::v1::ServicePerimeter > >

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

DeleteServicePerimeter(std::string const &, Options)

Deletes a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name.

The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] is removed from long-lasting storage.

Parameters
Name Description
name std::string const &

Required. Resource name for the [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].
Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}
opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::AccessContextManagerOperationMetadata > >

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

DeleteServicePerimeter(google::identity::accesscontextmanager::v1::DeleteServicePerimeterRequest const &, Options)

Deletes a [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] based on the resource name.

The long-running operation from this RPC has a successful status after the [service perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter] is removed from long-lasting storage.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::DeleteServicePerimeterRequest 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.identity.accesscontextmanager.v1.DeleteServicePerimeterRequest. 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::identity::accesscontextmanager::v1::AccessContextManagerOperationMetadata > >

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

ReplaceServicePerimeters(google::identity::accesscontextmanager::v1::ReplaceServicePerimetersRequest const &, Options)

Replace all existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] with the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] provided.

This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::ReplaceServicePerimetersRequest 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.identity.accesscontextmanager.v1.ReplaceServicePerimetersRequest. 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::identity::accesscontextmanager::v1::ReplaceServicePerimetersResponse > >

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

CommitServicePerimeters(google::identity::accesscontextmanager::v1::CommitServicePerimetersRequest const &, Options)

Commits the dry-run specification for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] in an access policy.

A commit operation on a service perimeter involves copying its spec field to the status field of the service perimeter. Only [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] with use_explicit_dry_run_spec field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The dry_run and the spec fields are cleared after a successful commit operation.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::CommitServicePerimetersRequest 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.identity.accesscontextmanager.v1.CommitServicePerimetersRequest. 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::identity::accesscontextmanager::v1::CommitServicePerimetersResponse > >

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

ListGcpUserAccessBindings(std::string const &, Options)

Lists all [GcpUserAccessBindings] google.identity.accesscontextmanager.v1.GcpUserAccessBinding for a Google Cloud organization.

Parameters
Name Description
parent std::string const &

Required. Example: "organizations/256"

opts Options

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

Returns
Type Description
StreamRange< google::identity::accesscontextmanager::v1::GcpUserAccessBinding >

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

ListGcpUserAccessBindings(google::identity::accesscontextmanager::v1::ListGcpUserAccessBindingsRequest, Options)

Lists all [GcpUserAccessBindings] google.identity.accesscontextmanager.v1.GcpUserAccessBinding for a Google Cloud organization.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::ListGcpUserAccessBindingsRequest

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.identity.accesscontextmanager.v1.ListGcpUserAccessBindingsRequest. 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::identity::accesscontextmanager::v1::GcpUserAccessBinding >

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

GetGcpUserAccessBinding(std::string const &, Options)

Gets the [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding with the given name.

Parameters
Name Description
name std::string const &

Required. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"

opts Options

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

Returns
Type Description
StatusOr< google::identity::accesscontextmanager::v1::GcpUserAccessBinding >

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

GetGcpUserAccessBinding(google::identity::accesscontextmanager::v1::GetGcpUserAccessBindingRequest const &, Options)

Gets the [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding with the given name.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::GetGcpUserAccessBindingRequest 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.identity.accesscontextmanager.v1.GetGcpUserAccessBindingRequest. 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::identity::accesscontextmanager::v1::GcpUserAccessBinding >

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

CreateGcpUserAccessBinding(std::string const &, google::identity::accesscontextmanager::v1::GcpUserAccessBinding const &, Options)

Creates a [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding.

If the client specifies a [name] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.name], the server ignores it. Fails if a resource already exists with the same [group_key] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.group_key]. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

Parameters
Name Description
parent std::string const &

Required. Example: "organizations/256"

gcp_user_access_binding google::identity::accesscontextmanager::v1::GcpUserAccessBinding const &

Required. [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding
opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::GcpUserAccessBinding > >

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

CreateGcpUserAccessBinding(google::identity::accesscontextmanager::v1::CreateGcpUserAccessBindingRequest const &, Options)

Creates a [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding.

If the client specifies a [name] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.name], the server ignores it. Fails if a resource already exists with the same [group_key] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding.group_key]. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::CreateGcpUserAccessBindingRequest 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.identity.accesscontextmanager.v1.CreateGcpUserAccessBindingRequest. 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::identity::accesscontextmanager::v1::GcpUserAccessBinding > >

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

UpdateGcpUserAccessBinding(google::identity::accesscontextmanager::v1::GcpUserAccessBinding const &, google::protobuf::FieldMask const &, Options)

Updates a [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding.

Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Parameters
Name Description
gcp_user_access_binding google::identity::accesscontextmanager::v1::GcpUserAccessBinding const &

Required. [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding
update_mask google::protobuf::FieldMask const &

Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and must always be:
update_mask { paths: "access_levels" }

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::GcpUserAccessBinding > >

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

UpdateGcpUserAccessBinding(google::identity::accesscontextmanager::v1::UpdateGcpUserAccessBindingRequest const &, Options)

Updates a [GcpUserAccessBinding] google.identity.accesscontextmanager.v1.GcpUserAccessBinding.

Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::UpdateGcpUserAccessBindingRequest 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.identity.accesscontextmanager.v1.UpdateGcpUserAccessBindingRequest. 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::identity::accesscontextmanager::v1::GcpUserAccessBinding > >

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

DeleteGcpUserAccessBinding(std::string const &, Options)

Deletes a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding].

Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

Parameters
Name Description
name std::string const &

Required. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"

opts Options

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

Returns
Type Description
future< StatusOr< google::identity::accesscontextmanager::v1::GcpUserAccessBindingOperationMetadata > >

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

DeleteGcpUserAccessBinding(google::identity::accesscontextmanager::v1::DeleteGcpUserAccessBindingRequest const &, Options)

Deletes a [GcpUserAccessBinding] [google.identity.accesscontextmanager.v1.GcpUserAccessBinding].

Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

Parameters
Name Description
request google::identity::accesscontextmanager::v1::DeleteGcpUserAccessBindingRequest 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.identity.accesscontextmanager.v1.DeleteGcpUserAccessBindingRequest. 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::identity::accesscontextmanager::v1::GcpUserAccessBindingOperationMetadata > >

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

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the IAM policy for the specified Access Context Manager access policy.

This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest 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.v1.SetIamPolicyRequest. 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::v1::Policy >

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

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the IAM policy for the specified Access Context Manager access policy.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest 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.v1.GetIamPolicyRequest. 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::v1::Policy >

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

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns the IAM permissions that the caller has on the specified Access Context Manager resource.

The resource can be an AccessPolicy, AccessLevel, or [ServicePerimeter][google.identity.accesscontextmanager.v1.ServicePerimeter ]. This method does not support other resources.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest 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.v1.TestIamPermissionsRequest. 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::v1::TestIamPermissionsResponse >

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