Class AccessContextManagerClient (1.21.0)

public class AccessContextManagerClient implements BackgroundResource

Service Description: 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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName name = AccessPolicyName.of("[ACCESS_POLICY]");
   AccessPolicy response = accessContextManagerClient.getAccessPolicy(name);
 }
 

Note: close() needs to be called on the AccessContextManagerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AccessContextManagerSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessContextManagerSettings accessContextManagerSettings =
     AccessContextManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create(accessContextManagerSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessContextManagerSettings accessContextManagerSettings =
     AccessContextManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create(accessContextManagerSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessContextManagerSettings accessContextManagerSettings =
     AccessContextManagerSettings.newHttpJsonBuilder().build();
 AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create(accessContextManagerSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > AccessContextManagerClient

Implements

BackgroundResource

Static Methods

create()

public static final AccessContextManagerClient create()

Constructs an instance of AccessContextManagerClient with default settings.

Returns
TypeDescription
AccessContextManagerClient
Exceptions
TypeDescription
IOException

create(AccessContextManagerSettings settings)

public static final AccessContextManagerClient create(AccessContextManagerSettings settings)

Constructs an instance of AccessContextManagerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsAccessContextManagerSettings
Returns
TypeDescription
AccessContextManagerClient
Exceptions
TypeDescription
IOException

create(AccessContextManagerStub stub)

public static final AccessContextManagerClient create(AccessContextManagerStub stub)

Constructs an instance of AccessContextManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(AccessContextManagerSettings).

Parameter
NameDescription
stubAccessContextManagerStub
Returns
TypeDescription
AccessContextManagerClient

Constructors

AccessContextManagerClient(AccessContextManagerSettings settings)

protected AccessContextManagerClient(AccessContextManagerSettings settings)

Constructs an instance of AccessContextManagerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsAccessContextManagerSettings

AccessContextManagerClient(AccessContextManagerStub stub)

protected AccessContextManagerClient(AccessContextManagerStub stub)
Parameter
NameDescription
stubAccessContextManagerStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

commitServicePerimetersAsync(CommitServicePerimetersRequest request)

public final OperationFuture<CommitServicePerimetersResponse,AccessContextManagerOperationMetadata> commitServicePerimetersAsync(CommitServicePerimetersRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CommitServicePerimetersRequest request =
       CommitServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setEtag("etag3123477")
           .build();
   CommitServicePerimetersResponse response =
       accessContextManagerClient.commitServicePerimetersAsync(request).get();
 }
 
Parameter
NameDescription
requestCommitServicePerimetersRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<CommitServicePerimetersResponse,AccessContextManagerOperationMetadata>

commitServicePerimetersCallable()

public final UnaryCallable<CommitServicePerimetersRequest,Operation> commitServicePerimetersCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CommitServicePerimetersRequest request =
       CommitServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.commitServicePerimetersCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CommitServicePerimetersRequest,Operation>

commitServicePerimetersOperationCallable()

public final OperationCallable<CommitServicePerimetersRequest,CommitServicePerimetersResponse,AccessContextManagerOperationMetadata> commitServicePerimetersOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CommitServicePerimetersRequest request =
       CommitServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<CommitServicePerimetersResponse, AccessContextManagerOperationMetadata>
       future =
           accessContextManagerClient
               .commitServicePerimetersOperationCallable()
               .futureCall(request);
   // Do something.
   CommitServicePerimetersResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CommitServicePerimetersRequest,CommitServicePerimetersResponse,AccessContextManagerOperationMetadata>

createAccessLevelAsync(AccessPolicyName parent, AccessLevel accessLevel)

public final OperationFuture<AccessLevel,AccessContextManagerOperationMetadata> createAccessLevelAsync(AccessPolicyName parent, AccessLevel accessLevel)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName parent = AccessPolicyName.of("[ACCESS_POLICY]");
   AccessLevel accessLevel = AccessLevel.newBuilder().build();
   AccessLevel response =
       accessContextManagerClient.createAccessLevelAsync(parent, accessLevel).get();
 }
 
Parameters
NameDescription
parentAccessPolicyName

Required. Resource name for the access policy which owns this [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].

Format: accessPolicies/{policy_id}

accessLevelAccessLevel

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.

Returns
TypeDescription
OperationFuture<AccessLevel,AccessContextManagerOperationMetadata>

createAccessLevelAsync(CreateAccessLevelRequest request)

public final OperationFuture<AccessLevel,AccessContextManagerOperationMetadata> createAccessLevelAsync(CreateAccessLevelRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateAccessLevelRequest request =
       CreateAccessLevelRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setAccessLevel(AccessLevel.newBuilder().build())
           .build();
   AccessLevel response = accessContextManagerClient.createAccessLevelAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateAccessLevelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AccessLevel,AccessContextManagerOperationMetadata>

createAccessLevelAsync(String parent, AccessLevel accessLevel)

public final OperationFuture<AccessLevel,AccessContextManagerOperationMetadata> createAccessLevelAsync(String parent, AccessLevel accessLevel)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String parent = AccessPolicyName.of("[ACCESS_POLICY]").toString();
   AccessLevel accessLevel = AccessLevel.newBuilder().build();
   AccessLevel response =
       accessContextManagerClient.createAccessLevelAsync(parent, accessLevel).get();
 }
 
Parameters
NameDescription
parentString

Required. Resource name for the access policy which owns this [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].

Format: accessPolicies/{policy_id}

accessLevelAccessLevel

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.

Returns
TypeDescription
OperationFuture<AccessLevel,AccessContextManagerOperationMetadata>

createAccessLevelCallable()

public final UnaryCallable<CreateAccessLevelRequest,Operation> createAccessLevelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateAccessLevelRequest request =
       CreateAccessLevelRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setAccessLevel(AccessLevel.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.createAccessLevelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateAccessLevelRequest,Operation>

createAccessLevelOperationCallable()

public final OperationCallable<CreateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata> createAccessLevelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateAccessLevelRequest request =
       CreateAccessLevelRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setAccessLevel(AccessLevel.newBuilder().build())
           .build();
   OperationFuture<AccessLevel, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.createAccessLevelOperationCallable().futureCall(request);
   // Do something.
   AccessLevel response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata>

createAccessPolicyAsync(AccessPolicy request)

public final OperationFuture<AccessPolicy,AccessContextManagerOperationMetadata> createAccessPolicyAsync(AccessPolicy request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicy request =
       AccessPolicy.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setParent("parent-995424086")
           .setTitle("title110371416")
           .addAllScopes(new ArrayList<String>())
           .setCreateTime(Timestamp.newBuilder().build())
           .setUpdateTime(Timestamp.newBuilder().build())
           .setEtag("etag3123477")
           .build();
   AccessPolicy response = accessContextManagerClient.createAccessPolicyAsync(request).get();
 }
 
Parameter
NameDescription
requestAccessPolicy

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AccessPolicy,AccessContextManagerOperationMetadata>

createAccessPolicyCallable()

public final UnaryCallable<AccessPolicy,Operation> createAccessPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicy request =
       AccessPolicy.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setParent("parent-995424086")
           .setTitle("title110371416")
           .addAllScopes(new ArrayList<String>())
           .setCreateTime(Timestamp.newBuilder().build())
           .setUpdateTime(Timestamp.newBuilder().build())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.createAccessPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<AccessPolicy,Operation>

createAccessPolicyOperationCallable()

public final OperationCallable<AccessPolicy,AccessPolicy,AccessContextManagerOperationMetadata> createAccessPolicyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicy request =
       AccessPolicy.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setParent("parent-995424086")
           .setTitle("title110371416")
           .addAllScopes(new ArrayList<String>())
           .setCreateTime(Timestamp.newBuilder().build())
           .setUpdateTime(Timestamp.newBuilder().build())
           .setEtag("etag3123477")
           .build();
   OperationFuture<AccessPolicy, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.createAccessPolicyOperationCallable().futureCall(request);
   // Do something.
   AccessPolicy response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<AccessPolicy,AccessPolicy,AccessContextManagerOperationMetadata>

createGcpUserAccessBindingAsync(CreateGcpUserAccessBindingRequest request)

public final OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> createGcpUserAccessBindingAsync(CreateGcpUserAccessBindingRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateGcpUserAccessBindingRequest request =
       CreateGcpUserAccessBindingRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setGcpUserAccessBinding(GcpUserAccessBinding.newBuilder().build())
           .build();
   GcpUserAccessBinding response =
       accessContextManagerClient.createGcpUserAccessBindingAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateGcpUserAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

createGcpUserAccessBindingAsync(OrganizationName parent, GcpUserAccessBinding gcpUserAccessBinding)

public final OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> createGcpUserAccessBindingAsync(OrganizationName parent, GcpUserAccessBinding gcpUserAccessBinding)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   GcpUserAccessBinding gcpUserAccessBinding = GcpUserAccessBinding.newBuilder().build();
   GcpUserAccessBinding response =
       accessContextManagerClient
           .createGcpUserAccessBindingAsync(parent, gcpUserAccessBinding)
           .get();
 }
 
Parameters
NameDescription
parentOrganizationName

Required. Example: "organizations/256"

gcpUserAccessBindingGcpUserAccessBinding

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

Returns
TypeDescription
OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

createGcpUserAccessBindingAsync(String parent, GcpUserAccessBinding gcpUserAccessBinding)

public final OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> createGcpUserAccessBindingAsync(String parent, GcpUserAccessBinding gcpUserAccessBinding)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   GcpUserAccessBinding gcpUserAccessBinding = GcpUserAccessBinding.newBuilder().build();
   GcpUserAccessBinding response =
       accessContextManagerClient
           .createGcpUserAccessBindingAsync(parent, gcpUserAccessBinding)
           .get();
 }
 
Parameters
NameDescription
parentString

Required. Example: "organizations/256"

gcpUserAccessBindingGcpUserAccessBinding

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

Returns
TypeDescription
OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

createGcpUserAccessBindingCallable()

public final UnaryCallable<CreateGcpUserAccessBindingRequest,Operation> createGcpUserAccessBindingCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateGcpUserAccessBindingRequest request =
       CreateGcpUserAccessBindingRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setGcpUserAccessBinding(GcpUserAccessBinding.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.createGcpUserAccessBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateGcpUserAccessBindingRequest,Operation>

createGcpUserAccessBindingOperationCallable()

public final OperationCallable<CreateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> createGcpUserAccessBindingOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateGcpUserAccessBindingRequest request =
       CreateGcpUserAccessBindingRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setGcpUserAccessBinding(GcpUserAccessBinding.newBuilder().build())
           .build();
   OperationFuture<GcpUserAccessBinding, GcpUserAccessBindingOperationMetadata> future =
       accessContextManagerClient
           .createGcpUserAccessBindingOperationCallable()
           .futureCall(request);
   // Do something.
   GcpUserAccessBinding response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

createServicePerimeterAsync(AccessPolicyName parent, ServicePerimeter servicePerimeter)

public final OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata> createServicePerimeterAsync(AccessPolicyName parent, ServicePerimeter servicePerimeter)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName parent = AccessPolicyName.of("[ACCESS_POLICY]");
   ServicePerimeter servicePerimeter = ServicePerimeter.newBuilder().build();
   ServicePerimeter response =
       accessContextManagerClient.createServicePerimeterAsync(parent, servicePerimeter).get();
 }
 
Parameters
NameDescription
parentAccessPolicyName

Required. Resource name for the access policy which owns this [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].

Format: accessPolicies/{policy_id}

servicePerimeterServicePerimeter

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.

Returns
TypeDescription
OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata>

createServicePerimeterAsync(CreateServicePerimeterRequest request)

public final OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata> createServicePerimeterAsync(CreateServicePerimeterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateServicePerimeterRequest request =
       CreateServicePerimeterRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setServicePerimeter(ServicePerimeter.newBuilder().build())
           .build();
   ServicePerimeter response =
       accessContextManagerClient.createServicePerimeterAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateServicePerimeterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata>

createServicePerimeterAsync(String parent, ServicePerimeter servicePerimeter)

public final OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata> createServicePerimeterAsync(String parent, ServicePerimeter servicePerimeter)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String parent = AccessPolicyName.of("[ACCESS_POLICY]").toString();
   ServicePerimeter servicePerimeter = ServicePerimeter.newBuilder().build();
   ServicePerimeter response =
       accessContextManagerClient.createServicePerimeterAsync(parent, servicePerimeter).get();
 }
 
Parameters
NameDescription
parentString

Required. Resource name for the access policy which owns this [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].

Format: accessPolicies/{policy_id}

servicePerimeterServicePerimeter

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.

Returns
TypeDescription
OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata>

createServicePerimeterCallable()

public final UnaryCallable<CreateServicePerimeterRequest,Operation> createServicePerimeterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateServicePerimeterRequest request =
       CreateServicePerimeterRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setServicePerimeter(ServicePerimeter.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.createServicePerimeterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateServicePerimeterRequest,Operation>

createServicePerimeterOperationCallable()

public final OperationCallable<CreateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata> createServicePerimeterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   CreateServicePerimeterRequest request =
       CreateServicePerimeterRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setServicePerimeter(ServicePerimeter.newBuilder().build())
           .build();
   OperationFuture<ServicePerimeter, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.createServicePerimeterOperationCallable().futureCall(request);
   // Do something.
   ServicePerimeter response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata>

deleteAccessLevelAsync(AccessLevelName name)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteAccessLevelAsync(AccessLevelName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessLevelName name = AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]");
   accessContextManagerClient.deleteAccessLevelAsync(name).get();
 }
 
Parameter
NameDescription
nameAccessLevelName

Required. Resource name for the [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].

Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteAccessLevelAsync(DeleteAccessLevelRequest request)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteAccessLevelAsync(DeleteAccessLevelRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteAccessLevelRequest request =
       DeleteAccessLevelRequest.newBuilder()
           .setName(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .build();
   accessContextManagerClient.deleteAccessLevelAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteAccessLevelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteAccessLevelAsync(String name)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteAccessLevelAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name = AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString();
   accessContextManagerClient.deleteAccessLevelAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Resource name for the [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].

Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteAccessLevelCallable()

public final UnaryCallable<DeleteAccessLevelRequest,Operation> deleteAccessLevelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteAccessLevelRequest request =
       DeleteAccessLevelRequest.newBuilder()
           .setName(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.deleteAccessLevelCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteAccessLevelRequest,Operation>

deleteAccessLevelOperationCallable()

public final OperationCallable<DeleteAccessLevelRequest,Empty,AccessContextManagerOperationMetadata> deleteAccessLevelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteAccessLevelRequest request =
       DeleteAccessLevelRequest.newBuilder()
           .setName(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .build();
   OperationFuture<Empty, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.deleteAccessLevelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteAccessLevelRequest,Empty,AccessContextManagerOperationMetadata>

deleteAccessPolicyAsync(AccessPolicyName name)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteAccessPolicyAsync(AccessPolicyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName name = AccessPolicyName.of("[ACCESS_POLICY]");
   accessContextManagerClient.deleteAccessPolicyAsync(name).get();
 }
 
Parameter
NameDescription
nameAccessPolicyName

Required. Resource name for the access policy to delete.

Format accessPolicies/{policy_id}

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteAccessPolicyAsync(DeleteAccessPolicyRequest request)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteAccessPolicyAsync(DeleteAccessPolicyRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteAccessPolicyRequest request =
       DeleteAccessPolicyRequest.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .build();
   accessContextManagerClient.deleteAccessPolicyAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteAccessPolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteAccessPolicyAsync(String name)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteAccessPolicyAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name = AccessPolicyName.of("[ACCESS_POLICY]").toString();
   accessContextManagerClient.deleteAccessPolicyAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Resource name for the access policy to delete.

Format accessPolicies/{policy_id}

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteAccessPolicyCallable()

public final UnaryCallable<DeleteAccessPolicyRequest,Operation> deleteAccessPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteAccessPolicyRequest request =
       DeleteAccessPolicyRequest.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.deleteAccessPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteAccessPolicyRequest,Operation>

deleteAccessPolicyOperationCallable()

public final OperationCallable<DeleteAccessPolicyRequest,Empty,AccessContextManagerOperationMetadata> deleteAccessPolicyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteAccessPolicyRequest request =
       DeleteAccessPolicyRequest.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .build();
   OperationFuture<Empty, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.deleteAccessPolicyOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteAccessPolicyRequest,Empty,AccessContextManagerOperationMetadata>

deleteGcpUserAccessBindingAsync(DeleteGcpUserAccessBindingRequest request)

public final OperationFuture<Empty,GcpUserAccessBindingOperationMetadata> deleteGcpUserAccessBindingAsync(DeleteGcpUserAccessBindingRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteGcpUserAccessBindingRequest request =
       DeleteGcpUserAccessBindingRequest.newBuilder()
           .setName(
               GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]")
                   .toString())
           .build();
   accessContextManagerClient.deleteGcpUserAccessBindingAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteGcpUserAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,GcpUserAccessBindingOperationMetadata>

deleteGcpUserAccessBindingAsync(GcpUserAccessBindingName name)

public final OperationFuture<Empty,GcpUserAccessBindingOperationMetadata> deleteGcpUserAccessBindingAsync(GcpUserAccessBindingName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GcpUserAccessBindingName name =
       GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]");
   accessContextManagerClient.deleteGcpUserAccessBindingAsync(name).get();
 }
 
Parameter
NameDescription
nameGcpUserAccessBindingName

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

Returns
TypeDescription
OperationFuture<Empty,GcpUserAccessBindingOperationMetadata>

deleteGcpUserAccessBindingAsync(String name)

public final OperationFuture<Empty,GcpUserAccessBindingOperationMetadata> deleteGcpUserAccessBindingAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name =
       GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]").toString();
   accessContextManagerClient.deleteGcpUserAccessBindingAsync(name).get();
 }
 
Parameter
NameDescription
nameString

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

Returns
TypeDescription
OperationFuture<Empty,GcpUserAccessBindingOperationMetadata>

deleteGcpUserAccessBindingCallable()

public final UnaryCallable<DeleteGcpUserAccessBindingRequest,Operation> deleteGcpUserAccessBindingCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteGcpUserAccessBindingRequest request =
       DeleteGcpUserAccessBindingRequest.newBuilder()
           .setName(
               GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.deleteGcpUserAccessBindingCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteGcpUserAccessBindingRequest,Operation>

deleteGcpUserAccessBindingOperationCallable()

public final OperationCallable<DeleteGcpUserAccessBindingRequest,Empty,GcpUserAccessBindingOperationMetadata> deleteGcpUserAccessBindingOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteGcpUserAccessBindingRequest request =
       DeleteGcpUserAccessBindingRequest.newBuilder()
           .setName(
               GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]")
                   .toString())
           .build();
   OperationFuture<Empty, GcpUserAccessBindingOperationMetadata> future =
       accessContextManagerClient
           .deleteGcpUserAccessBindingOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteGcpUserAccessBindingRequest,Empty,GcpUserAccessBindingOperationMetadata>

deleteServicePerimeterAsync(DeleteServicePerimeterRequest request)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteServicePerimeterAsync(DeleteServicePerimeterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteServicePerimeterRequest request =
       DeleteServicePerimeterRequest.newBuilder()
           .setName(ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString())
           .build();
   accessContextManagerClient.deleteServicePerimeterAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteServicePerimeterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteServicePerimeterAsync(ServicePerimeterName name)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteServicePerimeterAsync(ServicePerimeterName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ServicePerimeterName name = ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]");
   accessContextManagerClient.deleteServicePerimeterAsync(name).get();
 }
 
Parameter
NameDescription
nameServicePerimeterName

Required. Resource name for the [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].

Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteServicePerimeterAsync(String name)

public final OperationFuture<Empty,AccessContextManagerOperationMetadata> deleteServicePerimeterAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name = ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString();
   accessContextManagerClient.deleteServicePerimeterAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Resource name for the [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].

Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}

Returns
TypeDescription
OperationFuture<Empty,AccessContextManagerOperationMetadata>

deleteServicePerimeterCallable()

public final UnaryCallable<DeleteServicePerimeterRequest,Operation> deleteServicePerimeterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteServicePerimeterRequest request =
       DeleteServicePerimeterRequest.newBuilder()
           .setName(ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.deleteServicePerimeterCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteServicePerimeterRequest,Operation>

deleteServicePerimeterOperationCallable()

public final OperationCallable<DeleteServicePerimeterRequest,Empty,AccessContextManagerOperationMetadata> deleteServicePerimeterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   DeleteServicePerimeterRequest request =
       DeleteServicePerimeterRequest.newBuilder()
           .setName(ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString())
           .build();
   OperationFuture<Empty, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.deleteServicePerimeterOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteServicePerimeterRequest,Empty,AccessContextManagerOperationMetadata>

getAccessLevel(AccessLevelName name)

public final AccessLevel getAccessLevel(AccessLevelName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessLevelName name = AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]");
   AccessLevel response = accessContextManagerClient.getAccessLevel(name);
 }
 
Parameter
NameDescription
nameAccessLevelName

Required. Resource name for the [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].

Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

Returns
TypeDescription
AccessLevel

getAccessLevel(GetAccessLevelRequest request)

public final AccessLevel getAccessLevel(GetAccessLevelRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetAccessLevelRequest request =
       GetAccessLevelRequest.newBuilder()
           .setName(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .setAccessLevelFormat(LevelFormat.forNumber(0))
           .build();
   AccessLevel response = accessContextManagerClient.getAccessLevel(request);
 }
 
Parameter
NameDescription
requestGetAccessLevelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AccessLevel

getAccessLevel(String name)

public final AccessLevel getAccessLevel(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name = AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString();
   AccessLevel response = accessContextManagerClient.getAccessLevel(name);
 }
 
Parameter
NameDescription
nameString

Required. Resource name for the [Access Level] [google.identity.accesscontextmanager.v1.AccessLevel].

Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

Returns
TypeDescription
AccessLevel

getAccessLevelCallable()

public final UnaryCallable<GetAccessLevelRequest,AccessLevel> getAccessLevelCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetAccessLevelRequest request =
       GetAccessLevelRequest.newBuilder()
           .setName(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .setAccessLevelFormat(LevelFormat.forNumber(0))
           .build();
   ApiFuture<AccessLevel> future =
       accessContextManagerClient.getAccessLevelCallable().futureCall(request);
   // Do something.
   AccessLevel response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAccessLevelRequest,AccessLevel>

getAccessPolicy(AccessPolicyName name)

public final AccessPolicy getAccessPolicy(AccessPolicyName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName name = AccessPolicyName.of("[ACCESS_POLICY]");
   AccessPolicy response = accessContextManagerClient.getAccessPolicy(name);
 }
 
Parameter
NameDescription
nameAccessPolicyName

Required. Resource name for the access policy to get.

Format accessPolicies/{policy_id}

Returns
TypeDescription
AccessPolicy

getAccessPolicy(GetAccessPolicyRequest request)

public final AccessPolicy getAccessPolicy(GetAccessPolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetAccessPolicyRequest request =
       GetAccessPolicyRequest.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .build();
   AccessPolicy response = accessContextManagerClient.getAccessPolicy(request);
 }
 
Parameter
NameDescription
requestGetAccessPolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AccessPolicy

getAccessPolicy(String name)

public final AccessPolicy getAccessPolicy(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name = AccessPolicyName.of("[ACCESS_POLICY]").toString();
   AccessPolicy response = accessContextManagerClient.getAccessPolicy(name);
 }
 
Parameter
NameDescription
nameString

Required. Resource name for the access policy to get.

Format accessPolicies/{policy_id}

Returns
TypeDescription
AccessPolicy

getAccessPolicyCallable()

public final UnaryCallable<GetAccessPolicyRequest,AccessPolicy> getAccessPolicyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetAccessPolicyRequest request =
       GetAccessPolicyRequest.newBuilder()
           .setName(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .build();
   ApiFuture<AccessPolicy> future =
       accessContextManagerClient.getAccessPolicyCallable().futureCall(request);
   // Do something.
   AccessPolicy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAccessPolicyRequest,AccessPolicy>

getGcpUserAccessBinding(GcpUserAccessBindingName name)

public final GcpUserAccessBinding getGcpUserAccessBinding(GcpUserAccessBindingName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GcpUserAccessBindingName name =
       GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]");
   GcpUserAccessBinding response = accessContextManagerClient.getGcpUserAccessBinding(name);
 }
 
Parameter
NameDescription
nameGcpUserAccessBindingName

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

Returns
TypeDescription
GcpUserAccessBinding

getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request)

public final GcpUserAccessBinding getGcpUserAccessBinding(GetGcpUserAccessBindingRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetGcpUserAccessBindingRequest request =
       GetGcpUserAccessBindingRequest.newBuilder()
           .setName(
               GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]")
                   .toString())
           .build();
   GcpUserAccessBinding response = accessContextManagerClient.getGcpUserAccessBinding(request);
 }
 
Parameter
NameDescription
requestGetGcpUserAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
GcpUserAccessBinding

getGcpUserAccessBinding(String name)

public final GcpUserAccessBinding getGcpUserAccessBinding(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name =
       GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]").toString();
   GcpUserAccessBinding response = accessContextManagerClient.getGcpUserAccessBinding(name);
 }
 
Parameter
NameDescription
nameString

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

Returns
TypeDescription
GcpUserAccessBinding

getGcpUserAccessBindingCallable()

public final UnaryCallable<GetGcpUserAccessBindingRequest,GcpUserAccessBinding> getGcpUserAccessBindingCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetGcpUserAccessBindingRequest request =
       GetGcpUserAccessBindingRequest.newBuilder()
           .setName(
               GcpUserAccessBindingName.of("[ORGANIZATION]", "[GCP_USER_ACCESS_BINDING]")
                   .toString())
           .build();
   ApiFuture<GcpUserAccessBinding> future =
       accessContextManagerClient.getGcpUserAccessBindingCallable().futureCall(request);
   // Do something.
   GcpUserAccessBinding response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetGcpUserAccessBindingRequest,GcpUserAccessBinding>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = accessContextManagerClient.getIamPolicy(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       accessContextManagerClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getServicePerimeter(GetServicePerimeterRequest request)

public final ServicePerimeter getServicePerimeter(GetServicePerimeterRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetServicePerimeterRequest request =
       GetServicePerimeterRequest.newBuilder()
           .setName(ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString())
           .build();
   ServicePerimeter response = accessContextManagerClient.getServicePerimeter(request);
 }
 
Parameter
NameDescription
requestGetServicePerimeterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ServicePerimeter

getServicePerimeter(ServicePerimeterName name)

public final ServicePerimeter getServicePerimeter(ServicePerimeterName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ServicePerimeterName name = ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]");
   ServicePerimeter response = accessContextManagerClient.getServicePerimeter(name);
 }
 
Parameter
NameDescription
nameServicePerimeterName

Required. Resource name for the [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].

Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}

Returns
TypeDescription
ServicePerimeter

getServicePerimeter(String name)

public final ServicePerimeter getServicePerimeter(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String name = ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString();
   ServicePerimeter response = accessContextManagerClient.getServicePerimeter(name);
 }
 
Parameter
NameDescription
nameString

Required. Resource name for the [Service Perimeter] [google.identity.accesscontextmanager.v1.ServicePerimeter].

Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}

Returns
TypeDescription
ServicePerimeter

getServicePerimeterCallable()

public final UnaryCallable<GetServicePerimeterRequest,ServicePerimeter> getServicePerimeterCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GetServicePerimeterRequest request =
       GetServicePerimeterRequest.newBuilder()
           .setName(ServicePerimeterName.of("[ACCESS_POLICY]", "[SERVICE_PERIMETER]").toString())
           .build();
   ApiFuture<ServicePerimeter> future =
       accessContextManagerClient.getServicePerimeterCallable().futureCall(request);
   // Do something.
   ServicePerimeter response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetServicePerimeterRequest,ServicePerimeter>

getSettings()

public final AccessContextManagerSettings getSettings()
Returns
TypeDescription
AccessContextManagerSettings

getStub()

public AccessContextManagerStub getStub()
Returns
TypeDescription
AccessContextManagerStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listAccessLevels(AccessPolicyName parent)

public final AccessContextManagerClient.ListAccessLevelsPagedResponse listAccessLevels(AccessPolicyName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName parent = AccessPolicyName.of("[ACCESS_POLICY]");
   for (AccessLevel element : accessContextManagerClient.listAccessLevels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentAccessPolicyName

Required. Resource name for the access policy to list [Access Levels] [google.identity.accesscontextmanager.v1.AccessLevel] from.

Format: accessPolicies/{policy_id}

Returns
TypeDescription
AccessContextManagerClient.ListAccessLevelsPagedResponse

listAccessLevels(ListAccessLevelsRequest request)

public final AccessContextManagerClient.ListAccessLevelsPagedResponse listAccessLevels(ListAccessLevelsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListAccessLevelsRequest request =
       ListAccessLevelsRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setAccessLevelFormat(LevelFormat.forNumber(0))
           .build();
   for (AccessLevel element :
       accessContextManagerClient.listAccessLevels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAccessLevelsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AccessContextManagerClient.ListAccessLevelsPagedResponse

listAccessLevels(String parent)

public final AccessContextManagerClient.ListAccessLevelsPagedResponse listAccessLevels(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String parent = AccessPolicyName.of("[ACCESS_POLICY]").toString();
   for (AccessLevel element : accessContextManagerClient.listAccessLevels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. Resource name for the access policy to list [Access Levels] [google.identity.accesscontextmanager.v1.AccessLevel] from.

Format: accessPolicies/{policy_id}

Returns
TypeDescription
AccessContextManagerClient.ListAccessLevelsPagedResponse

listAccessLevelsCallable()

public final UnaryCallable<ListAccessLevelsRequest,ListAccessLevelsResponse> listAccessLevelsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListAccessLevelsRequest request =
       ListAccessLevelsRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setAccessLevelFormat(LevelFormat.forNumber(0))
           .build();
   while (true) {
     ListAccessLevelsResponse response =
         accessContextManagerClient.listAccessLevelsCallable().call(request);
     for (AccessLevel element : response.getAccessLevelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAccessLevelsRequest,ListAccessLevelsResponse>

listAccessLevelsPagedCallable()

public final UnaryCallable<ListAccessLevelsRequest,AccessContextManagerClient.ListAccessLevelsPagedResponse> listAccessLevelsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListAccessLevelsRequest request =
       ListAccessLevelsRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setAccessLevelFormat(LevelFormat.forNumber(0))
           .build();
   ApiFuture<AccessLevel> future =
       accessContextManagerClient.listAccessLevelsPagedCallable().futureCall(request);
   // Do something.
   for (AccessLevel element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAccessLevelsRequest,ListAccessLevelsPagedResponse>

listAccessPolicies(ListAccessPoliciesRequest request)

public final AccessContextManagerClient.ListAccessPoliciesPagedResponse listAccessPolicies(ListAccessPoliciesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListAccessPoliciesRequest request =
       ListAccessPoliciesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AccessPolicy element :
       accessContextManagerClient.listAccessPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAccessPoliciesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AccessContextManagerClient.ListAccessPoliciesPagedResponse

listAccessPoliciesCallable()

public final UnaryCallable<ListAccessPoliciesRequest,ListAccessPoliciesResponse> listAccessPoliciesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListAccessPoliciesRequest request =
       ListAccessPoliciesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAccessPoliciesResponse response =
         accessContextManagerClient.listAccessPoliciesCallable().call(request);
     for (AccessPolicy element : response.getAccessPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAccessPoliciesRequest,ListAccessPoliciesResponse>

listAccessPoliciesPagedCallable()

public final UnaryCallable<ListAccessPoliciesRequest,AccessContextManagerClient.ListAccessPoliciesPagedResponse> listAccessPoliciesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListAccessPoliciesRequest request =
       ListAccessPoliciesRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AccessPolicy> future =
       accessContextManagerClient.listAccessPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (AccessPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAccessPoliciesRequest,ListAccessPoliciesPagedResponse>

listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request)

public final AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse listGcpUserAccessBindings(ListGcpUserAccessBindingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListGcpUserAccessBindingsRequest request =
       ListGcpUserAccessBindingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (GcpUserAccessBinding element :
       accessContextManagerClient.listGcpUserAccessBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListGcpUserAccessBindingsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse

listGcpUserAccessBindings(OrganizationName parent)

public final AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse listGcpUserAccessBindings(OrganizationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (GcpUserAccessBinding element :
       accessContextManagerClient.listGcpUserAccessBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentOrganizationName

Required. Example: "organizations/256"

Returns
TypeDescription
AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse

listGcpUserAccessBindings(String parent)

public final AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse listGcpUserAccessBindings(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (GcpUserAccessBinding element :
       accessContextManagerClient.listGcpUserAccessBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. Example: "organizations/256"

Returns
TypeDescription
AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse

listGcpUserAccessBindingsCallable()

public final UnaryCallable<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsResponse> listGcpUserAccessBindingsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListGcpUserAccessBindingsRequest request =
       ListGcpUserAccessBindingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListGcpUserAccessBindingsResponse response =
         accessContextManagerClient.listGcpUserAccessBindingsCallable().call(request);
     for (GcpUserAccessBinding element : response.getGcpUserAccessBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsResponse>

listGcpUserAccessBindingsPagedCallable()

public final UnaryCallable<ListGcpUserAccessBindingsRequest,AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse> listGcpUserAccessBindingsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListGcpUserAccessBindingsRequest request =
       ListGcpUserAccessBindingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<GcpUserAccessBinding> future =
       accessContextManagerClient.listGcpUserAccessBindingsPagedCallable().futureCall(request);
   // Do something.
   for (GcpUserAccessBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsPagedResponse>

listServicePerimeters(AccessPolicyName parent)

public final AccessContextManagerClient.ListServicePerimetersPagedResponse listServicePerimeters(AccessPolicyName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicyName parent = AccessPolicyName.of("[ACCESS_POLICY]");
   for (ServicePerimeter element :
       accessContextManagerClient.listServicePerimeters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentAccessPolicyName

Required. Resource name for the access policy to list [Service Perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] from.

Format: accessPolicies/{policy_id}

Returns
TypeDescription
AccessContextManagerClient.ListServicePerimetersPagedResponse

listServicePerimeters(ListServicePerimetersRequest request)

public final AccessContextManagerClient.ListServicePerimetersPagedResponse listServicePerimeters(ListServicePerimetersRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListServicePerimetersRequest request =
       ListServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ServicePerimeter element :
       accessContextManagerClient.listServicePerimeters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListServicePerimetersRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AccessContextManagerClient.ListServicePerimetersPagedResponse

listServicePerimeters(String parent)

public final AccessContextManagerClient.ListServicePerimetersPagedResponse listServicePerimeters(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   String parent = AccessPolicyName.of("[ACCESS_POLICY]").toString();
   for (ServicePerimeter element :
       accessContextManagerClient.listServicePerimeters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. Resource name for the access policy to list [Service Perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] from.

Format: accessPolicies/{policy_id}

Returns
TypeDescription
AccessContextManagerClient.ListServicePerimetersPagedResponse

listServicePerimetersCallable()

public final UnaryCallable<ListServicePerimetersRequest,ListServicePerimetersResponse> listServicePerimetersCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListServicePerimetersRequest request =
       ListServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListServicePerimetersResponse response =
         accessContextManagerClient.listServicePerimetersCallable().call(request);
     for (ServicePerimeter element : response.getServicePerimetersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListServicePerimetersRequest,ListServicePerimetersResponse>

listServicePerimetersPagedCallable()

public final UnaryCallable<ListServicePerimetersRequest,AccessContextManagerClient.ListServicePerimetersPagedResponse> listServicePerimetersPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ListServicePerimetersRequest request =
       ListServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ServicePerimeter> future =
       accessContextManagerClient.listServicePerimetersPagedCallable().futureCall(request);
   // Do something.
   for (ServicePerimeter element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListServicePerimetersRequest,ListServicePerimetersPagedResponse>

replaceAccessLevelsAsync(ReplaceAccessLevelsRequest request)

public final OperationFuture<ReplaceAccessLevelsResponse,AccessContextManagerOperationMetadata> replaceAccessLevelsAsync(ReplaceAccessLevelsRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ReplaceAccessLevelsRequest request =
       ReplaceAccessLevelsRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .addAllAccessLevels(new ArrayList<AccessLevel>())
           .setEtag("etag3123477")
           .build();
   ReplaceAccessLevelsResponse response =
       accessContextManagerClient.replaceAccessLevelsAsync(request).get();
 }
 
Parameter
NameDescription
requestReplaceAccessLevelsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<ReplaceAccessLevelsResponse,AccessContextManagerOperationMetadata>

replaceAccessLevelsCallable()

public final UnaryCallable<ReplaceAccessLevelsRequest,Operation> replaceAccessLevelsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ReplaceAccessLevelsRequest request =
       ReplaceAccessLevelsRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .addAllAccessLevels(new ArrayList<AccessLevel>())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.replaceAccessLevelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ReplaceAccessLevelsRequest,Operation>

replaceAccessLevelsOperationCallable()

public final OperationCallable<ReplaceAccessLevelsRequest,ReplaceAccessLevelsResponse,AccessContextManagerOperationMetadata> replaceAccessLevelsOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ReplaceAccessLevelsRequest request =
       ReplaceAccessLevelsRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .addAllAccessLevels(new ArrayList<AccessLevel>())
           .setEtag("etag3123477")
           .build();
   OperationFuture<ReplaceAccessLevelsResponse, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.replaceAccessLevelsOperationCallable().futureCall(request);
   // Do something.
   ReplaceAccessLevelsResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<ReplaceAccessLevelsRequest,ReplaceAccessLevelsResponse,AccessContextManagerOperationMetadata>

replaceServicePerimetersAsync(ReplaceServicePerimetersRequest request)

public final OperationFuture<ReplaceServicePerimetersResponse,AccessContextManagerOperationMetadata> replaceServicePerimetersAsync(ReplaceServicePerimetersRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ReplaceServicePerimetersRequest request =
       ReplaceServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .addAllServicePerimeters(new ArrayList<ServicePerimeter>())
           .setEtag("etag3123477")
           .build();
   ReplaceServicePerimetersResponse response =
       accessContextManagerClient.replaceServicePerimetersAsync(request).get();
 }
 
Parameter
NameDescription
requestReplaceServicePerimetersRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<ReplaceServicePerimetersResponse,AccessContextManagerOperationMetadata>

replaceServicePerimetersCallable()

public final UnaryCallable<ReplaceServicePerimetersRequest,Operation> replaceServicePerimetersCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ReplaceServicePerimetersRequest request =
       ReplaceServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .addAllServicePerimeters(new ArrayList<ServicePerimeter>())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.replaceServicePerimetersCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ReplaceServicePerimetersRequest,Operation>

replaceServicePerimetersOperationCallable()

public final OperationCallable<ReplaceServicePerimetersRequest,ReplaceServicePerimetersResponse,AccessContextManagerOperationMetadata> replaceServicePerimetersOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ReplaceServicePerimetersRequest request =
       ReplaceServicePerimetersRequest.newBuilder()
           .setParent(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .addAllServicePerimeters(new ArrayList<ServicePerimeter>())
           .setEtag("etag3123477")
           .build();
   OperationFuture<ReplaceServicePerimetersResponse, AccessContextManagerOperationMetadata>
       future =
           accessContextManagerClient
               .replaceServicePerimetersOperationCallable()
               .futureCall(request);
   // Do something.
   ReplaceServicePerimetersResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<ReplaceServicePerimetersRequest,ReplaceServicePerimetersResponse,AccessContextManagerOperationMetadata>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = accessContextManagerClient.setIamPolicy(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(AccessPolicyName.of("[ACCESS_POLICY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       accessContextManagerClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = accessContextManagerClient.testIamPermissions(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(AccessLevelName.of("[ACCESS_POLICY]", "[ACCESS_LEVEL]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       accessContextManagerClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateAccessLevelAsync(AccessLevel accessLevel, FieldMask updateMask)

public final OperationFuture<AccessLevel,AccessContextManagerOperationMetadata> updateAccessLevelAsync(AccessLevel accessLevel, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessLevel accessLevel = AccessLevel.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AccessLevel response =
       accessContextManagerClient.updateAccessLevelAsync(accessLevel, updateMask).get();
 }
 
Parameters
NameDescription
accessLevelAccessLevel

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.

updateMaskFieldMask

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

Returns
TypeDescription
OperationFuture<AccessLevel,AccessContextManagerOperationMetadata>

updateAccessLevelAsync(UpdateAccessLevelRequest request)

public final OperationFuture<AccessLevel,AccessContextManagerOperationMetadata> updateAccessLevelAsync(UpdateAccessLevelRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateAccessLevelRequest request =
       UpdateAccessLevelRequest.newBuilder()
           .setAccessLevel(AccessLevel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AccessLevel response = accessContextManagerClient.updateAccessLevelAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateAccessLevelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AccessLevel,AccessContextManagerOperationMetadata>

updateAccessLevelCallable()

public final UnaryCallable<UpdateAccessLevelRequest,Operation> updateAccessLevelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateAccessLevelRequest request =
       UpdateAccessLevelRequest.newBuilder()
           .setAccessLevel(AccessLevel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.updateAccessLevelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateAccessLevelRequest,Operation>

updateAccessLevelOperationCallable()

public final OperationCallable<UpdateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata> updateAccessLevelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateAccessLevelRequest request =
       UpdateAccessLevelRequest.newBuilder()
           .setAccessLevel(AccessLevel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<AccessLevel, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.updateAccessLevelOperationCallable().futureCall(request);
   // Do something.
   AccessLevel response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata>

updateAccessPolicyAsync(AccessPolicy policy, FieldMask updateMask)

public final OperationFuture<AccessPolicy,AccessContextManagerOperationMetadata> updateAccessPolicyAsync(AccessPolicy policy, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   AccessPolicy policy = AccessPolicy.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AccessPolicy response =
       accessContextManagerClient.updateAccessPolicyAsync(policy, updateMask).get();
 }
 
Parameters
NameDescription
policyAccessPolicy

Required. The updated AccessPolicy.

updateMaskFieldMask

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

Returns
TypeDescription
OperationFuture<AccessPolicy,AccessContextManagerOperationMetadata>

updateAccessPolicyAsync(UpdateAccessPolicyRequest request)

public final OperationFuture<AccessPolicy,AccessContextManagerOperationMetadata> updateAccessPolicyAsync(UpdateAccessPolicyRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateAccessPolicyRequest request =
       UpdateAccessPolicyRequest.newBuilder()
           .setPolicy(AccessPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AccessPolicy response = accessContextManagerClient.updateAccessPolicyAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateAccessPolicyRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AccessPolicy,AccessContextManagerOperationMetadata>

updateAccessPolicyCallable()

public final UnaryCallable<UpdateAccessPolicyRequest,Operation> updateAccessPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateAccessPolicyRequest request =
       UpdateAccessPolicyRequest.newBuilder()
           .setPolicy(AccessPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.updateAccessPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateAccessPolicyRequest,Operation>

updateAccessPolicyOperationCallable()

public final OperationCallable<UpdateAccessPolicyRequest,AccessPolicy,AccessContextManagerOperationMetadata> updateAccessPolicyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateAccessPolicyRequest request =
       UpdateAccessPolicyRequest.newBuilder()
           .setPolicy(AccessPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<AccessPolicy, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.updateAccessPolicyOperationCallable().futureCall(request);
   // Do something.
   AccessPolicy response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateAccessPolicyRequest,AccessPolicy,AccessContextManagerOperationMetadata>

updateGcpUserAccessBindingAsync(GcpUserAccessBinding gcpUserAccessBinding, FieldMask updateMask)

public final OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> updateGcpUserAccessBindingAsync(GcpUserAccessBinding gcpUserAccessBinding, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   GcpUserAccessBinding gcpUserAccessBinding = GcpUserAccessBinding.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GcpUserAccessBinding response =
       accessContextManagerClient
           .updateGcpUserAccessBindingAsync(gcpUserAccessBinding, updateMask)
           .get();
 }
 
Parameters
NameDescription
gcpUserAccessBindingGcpUserAccessBinding

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

updateMaskFieldMask

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

Returns
TypeDescription
OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

updateGcpUserAccessBindingAsync(UpdateGcpUserAccessBindingRequest request)

public final OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> updateGcpUserAccessBindingAsync(UpdateGcpUserAccessBindingRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateGcpUserAccessBindingRequest request =
       UpdateGcpUserAccessBindingRequest.newBuilder()
           .setGcpUserAccessBinding(GcpUserAccessBinding.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   GcpUserAccessBinding response =
       accessContextManagerClient.updateGcpUserAccessBindingAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateGcpUserAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

updateGcpUserAccessBindingCallable()

public final UnaryCallable<UpdateGcpUserAccessBindingRequest,Operation> updateGcpUserAccessBindingCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateGcpUserAccessBindingRequest request =
       UpdateGcpUserAccessBindingRequest.newBuilder()
           .setGcpUserAccessBinding(GcpUserAccessBinding.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.updateGcpUserAccessBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateGcpUserAccessBindingRequest,Operation>

updateGcpUserAccessBindingOperationCallable()

public final OperationCallable<UpdateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> updateGcpUserAccessBindingOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateGcpUserAccessBindingRequest request =
       UpdateGcpUserAccessBindingRequest.newBuilder()
           .setGcpUserAccessBinding(GcpUserAccessBinding.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<GcpUserAccessBinding, GcpUserAccessBindingOperationMetadata> future =
       accessContextManagerClient
           .updateGcpUserAccessBindingOperationCallable()
           .futureCall(request);
   // Do something.
   GcpUserAccessBinding response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

updateServicePerimeterAsync(ServicePerimeter servicePerimeter, FieldMask updateMask)

public final OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata> updateServicePerimeterAsync(ServicePerimeter servicePerimeter, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   ServicePerimeter servicePerimeter = ServicePerimeter.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ServicePerimeter response =
       accessContextManagerClient
           .updateServicePerimeterAsync(servicePerimeter, updateMask)
           .get();
 }
 
Parameters
NameDescription
servicePerimeterServicePerimeter

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

updateMaskFieldMask

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

Returns
TypeDescription
OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata>

updateServicePerimeterAsync(UpdateServicePerimeterRequest request)

public final OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata> updateServicePerimeterAsync(UpdateServicePerimeterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateServicePerimeterRequest request =
       UpdateServicePerimeterRequest.newBuilder()
           .setServicePerimeter(ServicePerimeter.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ServicePerimeter response =
       accessContextManagerClient.updateServicePerimeterAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateServicePerimeterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<ServicePerimeter,AccessContextManagerOperationMetadata>

updateServicePerimeterCallable()

public final UnaryCallable<UpdateServicePerimeterRequest,Operation> updateServicePerimeterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateServicePerimeterRequest request =
       UpdateServicePerimeterRequest.newBuilder()
           .setServicePerimeter(ServicePerimeter.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       accessContextManagerClient.updateServicePerimeterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateServicePerimeterRequest,Operation>

updateServicePerimeterOperationCallable()

public final OperationCallable<UpdateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata> updateServicePerimeterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessContextManagerClient accessContextManagerClient =
     AccessContextManagerClient.create()) {
   UpdateServicePerimeterRequest request =
       UpdateServicePerimeterRequest.newBuilder()
           .setServicePerimeter(ServicePerimeter.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<ServicePerimeter, AccessContextManagerOperationMetadata> future =
       accessContextManagerClient.updateServicePerimeterOperationCallable().futureCall(request);
   // Do something.
   ServicePerimeter response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata>