Class PrincipalAccessBoundaryPoliciesClient (1.60.0)

GitHub RepositoryProduct Reference

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

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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   PrincipalAccessBoundaryPolicyName name =
       PrincipalAccessBoundaryPolicyName.of(
           "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]");
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient.getPrincipalAccessBoundaryPolicy(name);
 }
 

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

Methods
Method Description Method Variants

CreatePrincipalAccessBoundaryPolicy

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPrincipalAccessBoundaryPolicyAsync(CreatePrincipalAccessBoundaryPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createPrincipalAccessBoundaryPolicyAsync(OrganizationLocationName parent, PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)

  • createPrincipalAccessBoundaryPolicyAsync(String parent, PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPrincipalAccessBoundaryPolicyOperationCallable()

  • createPrincipalAccessBoundaryPolicyCallable()

GetPrincipalAccessBoundaryPolicy

Gets a principal access boundary policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicyName name)

  • getPrincipalAccessBoundaryPolicy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPrincipalAccessBoundaryPolicyCallable()

UpdatePrincipalAccessBoundaryPolicy

Updates a principal access boundary policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePrincipalAccessBoundaryPolicyAsync(UpdatePrincipalAccessBoundaryPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updatePrincipalAccessBoundaryPolicyAsync(PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePrincipalAccessBoundaryPolicyOperationCallable()

  • updatePrincipalAccessBoundaryPolicyCallable()

DeletePrincipalAccessBoundaryPolicy

Deletes a principal access boundary policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePrincipalAccessBoundaryPolicyAsync(DeletePrincipalAccessBoundaryPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deletePrincipalAccessBoundaryPolicyAsync(PrincipalAccessBoundaryPolicyName name)

  • deletePrincipalAccessBoundaryPolicyAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePrincipalAccessBoundaryPolicyOperationCallable()

  • deletePrincipalAccessBoundaryPolicyCallable()

ListPrincipalAccessBoundaryPolicies

Lists principal access boundary policies.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPrincipalAccessBoundaryPolicies(OrganizationLocationName parent)

  • listPrincipalAccessBoundaryPolicies(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPrincipalAccessBoundaryPoliciesPagedCallable()

  • listPrincipalAccessBoundaryPoliciesCallable()

SearchPrincipalAccessBoundaryPolicyBindings

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • searchPrincipalAccessBoundaryPolicyBindings(PrincipalAccessBoundaryPolicyName name)

  • searchPrincipalAccessBoundaryPolicyBindings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchPrincipalAccessBoundaryPolicyBindingsPagedCallable()

  • searchPrincipalAccessBoundaryPolicyBindingsCallable()

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 PrincipalAccessBoundaryPoliciesSettings 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
 PrincipalAccessBoundaryPoliciesSettings principalAccessBoundaryPoliciesSettings =
     PrincipalAccessBoundaryPoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create(principalAccessBoundaryPoliciesSettings);
 

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
 PrincipalAccessBoundaryPoliciesSettings principalAccessBoundaryPoliciesSettings =
     PrincipalAccessBoundaryPoliciesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create(principalAccessBoundaryPoliciesSettings);
 

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
 PrincipalAccessBoundaryPoliciesSettings principalAccessBoundaryPoliciesSettings =
     PrincipalAccessBoundaryPoliciesSettings.newHttpJsonBuilder().build();
 PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create(principalAccessBoundaryPoliciesSettings);
 

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

Inheritance

java.lang.Object > PrincipalAccessBoundaryPoliciesClient

Static Methods

create()

public static final PrincipalAccessBoundaryPoliciesClient create()

Constructs an instance of PrincipalAccessBoundaryPoliciesClient with default settings.

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient
Exceptions
Type Description
IOException

create(PrincipalAccessBoundaryPoliciesSettings settings)

public static final PrincipalAccessBoundaryPoliciesClient create(PrincipalAccessBoundaryPoliciesSettings settings)

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

Parameter
Name Description
settings PrincipalAccessBoundaryPoliciesSettings
Returns
Type Description
PrincipalAccessBoundaryPoliciesClient
Exceptions
Type Description
IOException

create(PrincipalAccessBoundaryPoliciesStub stub)

public static final PrincipalAccessBoundaryPoliciesClient create(PrincipalAccessBoundaryPoliciesStub stub)

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

Parameter
Name Description
stub PrincipalAccessBoundaryPoliciesStub
Returns
Type Description
PrincipalAccessBoundaryPoliciesClient

Constructors

PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesSettings settings)

protected PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesSettings settings)

Constructs an instance of PrincipalAccessBoundaryPoliciesClient, 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
Name Description
settings PrincipalAccessBoundaryPoliciesSettings

PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesStub stub)

protected PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesStub stub)
Parameter
Name Description
stub PrincipalAccessBoundaryPoliciesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createPrincipalAccessBoundaryPolicyAsync(CreatePrincipalAccessBoundaryPolicyRequest request)

public final OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata> createPrincipalAccessBoundaryPolicyAsync(CreatePrincipalAccessBoundaryPolicyRequest request)

Creates a principal access boundary policy, and returns a long running 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   CreatePrincipalAccessBoundaryPolicyRequest request =
       CreatePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPrincipalAccessBoundaryPolicyId("principalAccessBoundaryPolicyId-198573175")
           .setPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicy.newBuilder().build())
           .setValidateOnly(true)
           .build();
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient
           .createPrincipalAccessBoundaryPolicyAsync(request)
           .get();
 }
 
Parameter
Name Description
request CreatePrincipalAccessBoundaryPolicyRequest

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

Returns
Type Description
OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata>

createPrincipalAccessBoundaryPolicyAsync(OrganizationLocationName parent, PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)

public final OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata> createPrincipalAccessBoundaryPolicyAsync(OrganizationLocationName parent, PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)

Creates a principal access boundary policy, and returns a long running 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy =
       PrincipalAccessBoundaryPolicy.newBuilder().build();
   String principalAccessBoundaryPolicyId = "principalAccessBoundaryPolicyId-198573175";
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient
           .createPrincipalAccessBoundaryPolicyAsync(
               parent, principalAccessBoundaryPolicy, principalAccessBoundaryPolicyId)
           .get();
 }
 
Parameters
Name Description
parent OrganizationLocationName

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.

Format: organizations/{organization_id}/locations/{location}

principalAccessBoundaryPolicy PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

principalAccessBoundaryPolicyId String

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

Returns
Type Description
OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata>

createPrincipalAccessBoundaryPolicyAsync(String parent, PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)

public final OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata> createPrincipalAccessBoundaryPolicyAsync(String parent, PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)

Creates a principal access boundary policy, and returns a long running 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy =
       PrincipalAccessBoundaryPolicy.newBuilder().build();
   String principalAccessBoundaryPolicyId = "principalAccessBoundaryPolicyId-198573175";
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient
           .createPrincipalAccessBoundaryPolicyAsync(
               parent, principalAccessBoundaryPolicy, principalAccessBoundaryPolicyId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.

Format: organizations/{organization_id}/locations/{location}

principalAccessBoundaryPolicy PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

principalAccessBoundaryPolicyId String

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

Returns
Type Description
OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata>

createPrincipalAccessBoundaryPolicyCallable()

public final UnaryCallable<CreatePrincipalAccessBoundaryPolicyRequest,Operation> createPrincipalAccessBoundaryPolicyCallable()

Creates a principal access boundary policy, and returns a long running 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   CreatePrincipalAccessBoundaryPolicyRequest request =
       CreatePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPrincipalAccessBoundaryPolicyId("principalAccessBoundaryPolicyId-198573175")
           .setPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicy.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       principalAccessBoundaryPoliciesClient
           .createPrincipalAccessBoundaryPolicyCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreatePrincipalAccessBoundaryPolicyRequest,Operation>

createPrincipalAccessBoundaryPolicyOperationCallable()

public final OperationCallable<CreatePrincipalAccessBoundaryPolicyRequest,PrincipalAccessBoundaryPolicy,OperationMetadata> createPrincipalAccessBoundaryPolicyOperationCallable()

Creates a principal access boundary policy, and returns a long running 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   CreatePrincipalAccessBoundaryPolicyRequest request =
       CreatePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPrincipalAccessBoundaryPolicyId("principalAccessBoundaryPolicyId-198573175")
           .setPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicy.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<PrincipalAccessBoundaryPolicy, OperationMetadata> future =
       principalAccessBoundaryPoliciesClient
           .createPrincipalAccessBoundaryPolicyOperationCallable()
           .futureCall(request);
   // Do something.
   PrincipalAccessBoundaryPolicy response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreatePrincipalAccessBoundaryPolicyRequest,PrincipalAccessBoundaryPolicy,OperationMetadata>

deletePrincipalAccessBoundaryPolicyAsync(DeletePrincipalAccessBoundaryPolicyRequest request)

public final OperationFuture<Empty,OperationMetadata> deletePrincipalAccessBoundaryPolicyAsync(DeletePrincipalAccessBoundaryPolicyRequest request)

Deletes a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   DeletePrincipalAccessBoundaryPolicyRequest request =
       DeletePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setForce(true)
           .build();
   principalAccessBoundaryPoliciesClient.deletePrincipalAccessBoundaryPolicyAsync(request).get();
 }
 
Parameter
Name Description
request DeletePrincipalAccessBoundaryPolicyRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePrincipalAccessBoundaryPolicyAsync(PrincipalAccessBoundaryPolicyName name)

public final OperationFuture<Empty,OperationMetadata> deletePrincipalAccessBoundaryPolicyAsync(PrincipalAccessBoundaryPolicyName name)

Deletes a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   PrincipalAccessBoundaryPolicyName name =
       PrincipalAccessBoundaryPolicyName.of(
           "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]");
   principalAccessBoundaryPoliciesClient.deletePrincipalAccessBoundaryPolicyAsync(name).get();
 }
 
Parameter
Name Description
name PrincipalAccessBoundaryPolicyName

Required. The name of the principal access boundary policy to delete.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePrincipalAccessBoundaryPolicyAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deletePrincipalAccessBoundaryPolicyAsync(String name)

Deletes a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   String name =
       PrincipalAccessBoundaryPolicyName.of(
               "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
           .toString();
   principalAccessBoundaryPoliciesClient.deletePrincipalAccessBoundaryPolicyAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the principal access boundary policy to delete.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePrincipalAccessBoundaryPolicyCallable()

public final UnaryCallable<DeletePrincipalAccessBoundaryPolicyRequest,Operation> deletePrincipalAccessBoundaryPolicyCallable()

Deletes a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   DeletePrincipalAccessBoundaryPolicyRequest request =
       DeletePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       principalAccessBoundaryPoliciesClient
           .deletePrincipalAccessBoundaryPolicyCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeletePrincipalAccessBoundaryPolicyRequest,Operation>

deletePrincipalAccessBoundaryPolicyOperationCallable()

public final OperationCallable<DeletePrincipalAccessBoundaryPolicyRequest,Empty,OperationMetadata> deletePrincipalAccessBoundaryPolicyOperationCallable()

Deletes a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   DeletePrincipalAccessBoundaryPolicyRequest request =
       DeletePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       principalAccessBoundaryPoliciesClient
           .deletePrincipalAccessBoundaryPolicyOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeletePrincipalAccessBoundaryPolicyRequest,Empty,OperationMetadata>

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
Type Description
OperationsClient

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
Type Description
OperationsClient

getPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest request)

public final PrincipalAccessBoundaryPolicy getPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest request)

Gets a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   GetPrincipalAccessBoundaryPolicyRequest request =
       GetPrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .build();
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient.getPrincipalAccessBoundaryPolicy(request);
 }
 
Parameter
Name Description
request GetPrincipalAccessBoundaryPolicyRequest

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

Returns
Type Description
PrincipalAccessBoundaryPolicy

getPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicyName name)

public final PrincipalAccessBoundaryPolicy getPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicyName name)

Gets a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   PrincipalAccessBoundaryPolicyName name =
       PrincipalAccessBoundaryPolicyName.of(
           "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]");
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient.getPrincipalAccessBoundaryPolicy(name);
 }
 
Parameter
Name Description
name PrincipalAccessBoundaryPolicyName

Required. The name of the principal access boundary policy to retrieve.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Returns
Type Description
PrincipalAccessBoundaryPolicy

getPrincipalAccessBoundaryPolicy(String name)

public final PrincipalAccessBoundaryPolicy getPrincipalAccessBoundaryPolicy(String name)

Gets a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   String name =
       PrincipalAccessBoundaryPolicyName.of(
               "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
           .toString();
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient.getPrincipalAccessBoundaryPolicy(name);
 }
 
Parameter
Name Description
name String

Required. The name of the principal access boundary policy to retrieve.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Returns
Type Description
PrincipalAccessBoundaryPolicy

getPrincipalAccessBoundaryPolicyCallable()

public final UnaryCallable<GetPrincipalAccessBoundaryPolicyRequest,PrincipalAccessBoundaryPolicy> getPrincipalAccessBoundaryPolicyCallable()

Gets a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   GetPrincipalAccessBoundaryPolicyRequest request =
       GetPrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .build();
   ApiFuture<PrincipalAccessBoundaryPolicy> future =
       principalAccessBoundaryPoliciesClient
           .getPrincipalAccessBoundaryPolicyCallable()
           .futureCall(request);
   // Do something.
   PrincipalAccessBoundaryPolicy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetPrincipalAccessBoundaryPolicyRequest,PrincipalAccessBoundaryPolicy>

getSettings()

public final PrincipalAccessBoundaryPoliciesSettings getSettings()
Returns
Type Description
PrincipalAccessBoundaryPoliciesSettings

getStub()

public PrincipalAccessBoundaryPoliciesStub getStub()
Returns
Type Description
PrincipalAccessBoundaryPoliciesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest request)

public final PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse listPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest request)

Lists principal access boundary policies.

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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   ListPrincipalAccessBoundaryPoliciesRequest request =
       ListPrincipalAccessBoundaryPoliciesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PrincipalAccessBoundaryPolicy element :
       principalAccessBoundaryPoliciesClient
           .listPrincipalAccessBoundaryPolicies(request)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPrincipalAccessBoundaryPoliciesRequest

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

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse

listPrincipalAccessBoundaryPolicies(OrganizationLocationName parent)

public final PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse listPrincipalAccessBoundaryPolicies(OrganizationLocationName parent)

Lists principal access boundary policies.

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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (PrincipalAccessBoundaryPolicy element :
       principalAccessBoundaryPoliciesClient
           .listPrincipalAccessBoundaryPolicies(parent)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent OrganizationLocationName

Required. The parent resource, which owns the collection of principal access boundary policies.

Format: organizations/{organization_id}/locations/{location}

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse

listPrincipalAccessBoundaryPolicies(String parent)

public final PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse listPrincipalAccessBoundaryPolicies(String parent)

Lists principal access boundary policies.

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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (PrincipalAccessBoundaryPolicy element :
       principalAccessBoundaryPoliciesClient
           .listPrincipalAccessBoundaryPolicies(parent)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent resource, which owns the collection of principal access boundary policies.

Format: organizations/{organization_id}/locations/{location}

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse

listPrincipalAccessBoundaryPoliciesCallable()

public final UnaryCallable<ListPrincipalAccessBoundaryPoliciesRequest,ListPrincipalAccessBoundaryPoliciesResponse> listPrincipalAccessBoundaryPoliciesCallable()

Lists principal access boundary policies.

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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   ListPrincipalAccessBoundaryPoliciesRequest request =
       ListPrincipalAccessBoundaryPoliciesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPrincipalAccessBoundaryPoliciesResponse response =
         principalAccessBoundaryPoliciesClient
             .listPrincipalAccessBoundaryPoliciesCallable()
             .call(request);
     for (PrincipalAccessBoundaryPolicy element :
         response.getPrincipalAccessBoundaryPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrincipalAccessBoundaryPoliciesRequest,ListPrincipalAccessBoundaryPoliciesResponse>

listPrincipalAccessBoundaryPoliciesPagedCallable()

public final UnaryCallable<ListPrincipalAccessBoundaryPoliciesRequest,PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse> listPrincipalAccessBoundaryPoliciesPagedCallable()

Lists principal access boundary policies.

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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   ListPrincipalAccessBoundaryPoliciesRequest request =
       ListPrincipalAccessBoundaryPoliciesRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<PrincipalAccessBoundaryPolicy> future =
       principalAccessBoundaryPoliciesClient
           .listPrincipalAccessBoundaryPoliciesPagedCallable()
           .futureCall(request);
   // Do something.
   for (PrincipalAccessBoundaryPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrincipalAccessBoundaryPoliciesRequest,ListPrincipalAccessBoundaryPoliciesPagedResponse>

searchPrincipalAccessBoundaryPolicyBindings(PrincipalAccessBoundaryPolicyName name)

public final PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse searchPrincipalAccessBoundaryPolicyBindings(PrincipalAccessBoundaryPolicyName name)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   PrincipalAccessBoundaryPolicyName name =
       PrincipalAccessBoundaryPolicyName.of(
           "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]");
   for (PolicyBinding element :
       principalAccessBoundaryPoliciesClient
           .searchPrincipalAccessBoundaryPolicyBindings(name)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
name PrincipalAccessBoundaryPolicyName

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

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse

searchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest request)

public final PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse searchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest request)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   SearchPrincipalAccessBoundaryPolicyBindingsRequest request =
       SearchPrincipalAccessBoundaryPolicyBindingsRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PolicyBinding element :
       principalAccessBoundaryPoliciesClient
           .searchPrincipalAccessBoundaryPolicyBindings(request)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request SearchPrincipalAccessBoundaryPolicyBindingsRequest

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

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse

searchPrincipalAccessBoundaryPolicyBindings(String name)

public final PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse searchPrincipalAccessBoundaryPolicyBindings(String name)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   String name =
       PrincipalAccessBoundaryPolicyName.of(
               "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
           .toString();
   for (PolicyBinding element :
       principalAccessBoundaryPoliciesClient
           .searchPrincipalAccessBoundaryPolicyBindings(name)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse

searchPrincipalAccessBoundaryPolicyBindingsCallable()

public final UnaryCallable<SearchPrincipalAccessBoundaryPolicyBindingsRequest,SearchPrincipalAccessBoundaryPolicyBindingsResponse> searchPrincipalAccessBoundaryPolicyBindingsCallable()

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   SearchPrincipalAccessBoundaryPolicyBindingsRequest request =
       SearchPrincipalAccessBoundaryPolicyBindingsRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchPrincipalAccessBoundaryPolicyBindingsResponse response =
         principalAccessBoundaryPoliciesClient
             .searchPrincipalAccessBoundaryPolicyBindingsCallable()
             .call(request);
     for (PolicyBinding element : response.getPolicyBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<SearchPrincipalAccessBoundaryPolicyBindingsRequest,SearchPrincipalAccessBoundaryPolicyBindingsResponse>

searchPrincipalAccessBoundaryPolicyBindingsPagedCallable()

public final UnaryCallable<SearchPrincipalAccessBoundaryPolicyBindingsRequest,PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse> searchPrincipalAccessBoundaryPolicyBindingsPagedCallable()

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   SearchPrincipalAccessBoundaryPolicyBindingsRequest request =
       SearchPrincipalAccessBoundaryPolicyBindingsRequest.newBuilder()
           .setName(
               PrincipalAccessBoundaryPolicyName.of(
                       "[ORGANIZATION]", "[LOCATION]", "[PRINCIPAL_ACCESS_BOUNDARY_POLICY]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<PolicyBinding> future =
       principalAccessBoundaryPoliciesClient
           .searchPrincipalAccessBoundaryPolicyBindingsPagedCallable()
           .futureCall(request);
   // Do something.
   for (PolicyBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<SearchPrincipalAccessBoundaryPolicyBindingsRequest,SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updatePrincipalAccessBoundaryPolicyAsync(PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, FieldMask updateMask)

public final OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata> updatePrincipalAccessBoundaryPolicyAsync(PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, FieldMask updateMask)

Updates a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy =
       PrincipalAccessBoundaryPolicy.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient
           .updatePrincipalAccessBoundaryPolicyAsync(principalAccessBoundaryPolicy, updateMask)
           .get();
 }
 
Parameters
Name Description
principalAccessBoundaryPolicy PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to update.

The principal access boundary policy's name field is used to identify the policy to update.

updateMask FieldMask

Optional. The list of fields to update

Returns
Type Description
OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata>

updatePrincipalAccessBoundaryPolicyAsync(UpdatePrincipalAccessBoundaryPolicyRequest request)

public final OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata> updatePrincipalAccessBoundaryPolicyAsync(UpdatePrincipalAccessBoundaryPolicyRequest request)

Updates a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   UpdatePrincipalAccessBoundaryPolicyRequest request =
       UpdatePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicy.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PrincipalAccessBoundaryPolicy response =
       principalAccessBoundaryPoliciesClient
           .updatePrincipalAccessBoundaryPolicyAsync(request)
           .get();
 }
 
Parameter
Name Description
request UpdatePrincipalAccessBoundaryPolicyRequest

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

Returns
Type Description
OperationFuture<PrincipalAccessBoundaryPolicy,OperationMetadata>

updatePrincipalAccessBoundaryPolicyCallable()

public final UnaryCallable<UpdatePrincipalAccessBoundaryPolicyRequest,Operation> updatePrincipalAccessBoundaryPolicyCallable()

Updates a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   UpdatePrincipalAccessBoundaryPolicyRequest request =
       UpdatePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicy.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       principalAccessBoundaryPoliciesClient
           .updatePrincipalAccessBoundaryPolicyCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdatePrincipalAccessBoundaryPolicyRequest,Operation>

updatePrincipalAccessBoundaryPolicyOperationCallable()

public final OperationCallable<UpdatePrincipalAccessBoundaryPolicyRequest,PrincipalAccessBoundaryPolicy,OperationMetadata> updatePrincipalAccessBoundaryPolicyOperationCallable()

Updates a principal access boundary 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 (PrincipalAccessBoundaryPoliciesClient principalAccessBoundaryPoliciesClient =
     PrincipalAccessBoundaryPoliciesClient.create()) {
   UpdatePrincipalAccessBoundaryPolicyRequest request =
       UpdatePrincipalAccessBoundaryPolicyRequest.newBuilder()
           .setPrincipalAccessBoundaryPolicy(PrincipalAccessBoundaryPolicy.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<PrincipalAccessBoundaryPolicy, OperationMetadata> future =
       principalAccessBoundaryPoliciesClient
           .updatePrincipalAccessBoundaryPolicyOperationCallable()
           .futureCall(request);
   // Do something.
   PrincipalAccessBoundaryPolicy response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdatePrincipalAccessBoundaryPolicyRequest,PrincipalAccessBoundaryPolicy,OperationMetadata>