PrincipalAccessBoundaryPoliciesClient (Google IAM Policy 1.61.0 API)

java.lang.Object
- com.google.iam.v3beta.PrincipalAccessBoundaryPoliciesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class PrincipalAccessBoundaryPoliciesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesFixedSizeCollection`
`static class`	`PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPage`
`static class`	`PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse`
`static class`	`PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsFixedSizeCollection`
`static class`	`PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPage`
`static class`	`PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesSettings settings)` Constructs an instance of PrincipalAccessBoundaryPoliciesClient, using the given settings.
`protected`	`PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static PrincipalAccessBoundaryPoliciesClient`	`create()` Constructs an instance of PrincipalAccessBoundaryPoliciesClient with default settings.
`static PrincipalAccessBoundaryPoliciesClient`	`create(PrincipalAccessBoundaryPoliciesSettings settings)` Constructs an instance of PrincipalAccessBoundaryPoliciesClient, using the given settings.
`static PrincipalAccessBoundaryPoliciesClient`	`create(PrincipalAccessBoundaryPoliciesStub stub)` Constructs an instance of PrincipalAccessBoundaryPoliciesClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`createPrincipalAccessBoundaryPolicyAsync(com.google.iam.v3beta.CreatePrincipalAccessBoundaryPolicyRequest request)` Creates a principal access boundary policy, and returns a long running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`createPrincipalAccessBoundaryPolicyAsync(com.google.iam.v3beta.OrganizationLocationName parent, com.google.iam.v3beta.PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)` Creates a principal access boundary policy, and returns a long running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`createPrincipalAccessBoundaryPolicyAsync(String parent, com.google.iam.v3beta.PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, String principalAccessBoundaryPolicyId)` Creates a principal access boundary policy, and returns a long running operation.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.CreatePrincipalAccessBoundaryPolicyRequest,com.google.longrunning.Operation>`	`createPrincipalAccessBoundaryPolicyCallable()` Creates a principal access boundary policy, and returns a long running operation.
`com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.CreatePrincipalAccessBoundaryPolicyRequest,com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`createPrincipalAccessBoundaryPolicyOperationCallable()` Creates a principal access boundary policy, and returns a long running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePrincipalAccessBoundaryPolicyAsync(com.google.iam.v3beta.DeletePrincipalAccessBoundaryPolicyRequest request)` Deletes a principal access boundary policy.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePrincipalAccessBoundaryPolicyAsync(com.google.iam.v3beta.PrincipalAccessBoundaryPolicyName name)` Deletes a principal access boundary policy.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePrincipalAccessBoundaryPolicyAsync(String name)` Deletes a principal access boundary policy.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.DeletePrincipalAccessBoundaryPolicyRequest,com.google.longrunning.Operation>`	`deletePrincipalAccessBoundaryPolicyCallable()` Deletes a principal access boundary policy.
`com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.DeletePrincipalAccessBoundaryPolicyRequest,com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePrincipalAccessBoundaryPolicyOperationCallable()` Deletes a principal access boundary policy.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.iam.v3beta.PrincipalAccessBoundaryPolicy`	`getPrincipalAccessBoundaryPolicy(com.google.iam.v3beta.GetPrincipalAccessBoundaryPolicyRequest request)` Gets a principal access boundary policy.
`com.google.iam.v3beta.PrincipalAccessBoundaryPolicy`	`getPrincipalAccessBoundaryPolicy(com.google.iam.v3beta.PrincipalAccessBoundaryPolicyName name)` Gets a principal access boundary policy.
`com.google.iam.v3beta.PrincipalAccessBoundaryPolicy`	`getPrincipalAccessBoundaryPolicy(String name)` Gets a principal access boundary policy.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.GetPrincipalAccessBoundaryPolicyRequest,com.google.iam.v3beta.PrincipalAccessBoundaryPolicy>`	`getPrincipalAccessBoundaryPolicyCallable()` Gets a principal access boundary policy.
`PrincipalAccessBoundaryPoliciesSettings`	`getSettings()`
`PrincipalAccessBoundaryPoliciesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse`	`listPrincipalAccessBoundaryPolicies(com.google.iam.v3beta.ListPrincipalAccessBoundaryPoliciesRequest request)` Lists principal access boundary policies.
`PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse`	`listPrincipalAccessBoundaryPolicies(com.google.iam.v3beta.OrganizationLocationName parent)` Lists principal access boundary policies.
`PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse`	`listPrincipalAccessBoundaryPolicies(String parent)` Lists principal access boundary policies.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.ListPrincipalAccessBoundaryPoliciesRequest,com.google.iam.v3beta.ListPrincipalAccessBoundaryPoliciesResponse>`	`listPrincipalAccessBoundaryPoliciesCallable()` Lists principal access boundary policies.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.ListPrincipalAccessBoundaryPoliciesRequest,PrincipalAccessBoundaryPoliciesClient.ListPrincipalAccessBoundaryPoliciesPagedResponse>`	`listPrincipalAccessBoundaryPoliciesPagedCallable()` Lists principal access boundary policies.
`PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse`	`searchPrincipalAccessBoundaryPolicyBindings(com.google.iam.v3beta.PrincipalAccessBoundaryPolicyName name)` Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.
`PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse`	`searchPrincipalAccessBoundaryPolicyBindings(com.google.iam.v3beta.SearchPrincipalAccessBoundaryPolicyBindingsRequest request)` Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.
`PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse`	`searchPrincipalAccessBoundaryPolicyBindings(String name)` Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.SearchPrincipalAccessBoundaryPolicyBindingsRequest,com.google.iam.v3beta.SearchPrincipalAccessBoundaryPolicyBindingsResponse>`	`searchPrincipalAccessBoundaryPolicyBindingsCallable()` Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.SearchPrincipalAccessBoundaryPolicyBindingsRequest,PrincipalAccessBoundaryPoliciesClient.SearchPrincipalAccessBoundaryPolicyBindingsPagedResponse>`	`searchPrincipalAccessBoundaryPolicyBindingsPagedCallable()` Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`updatePrincipalAccessBoundaryPolicyAsync(com.google.iam.v3beta.PrincipalAccessBoundaryPolicy principalAccessBoundaryPolicy, com.google.protobuf.FieldMask updateMask)` Updates a principal access boundary policy.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`updatePrincipalAccessBoundaryPolicyAsync(com.google.iam.v3beta.UpdatePrincipalAccessBoundaryPolicyRequest request)` Updates a principal access boundary policy.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.UpdatePrincipalAccessBoundaryPolicyRequest,com.google.longrunning.Operation>`	`updatePrincipalAccessBoundaryPolicyCallable()` Updates a principal access boundary policy.
`com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.UpdatePrincipalAccessBoundaryPolicyRequest,com.google.iam.v3beta.PrincipalAccessBoundaryPolicy,com.google.iam.v3beta.OperationMetadata>`	`updatePrincipalAccessBoundaryPolicyOperationCallable()` Updates a principal access boundary policy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PrincipalAccessBoundaryPoliciesClient
```
protected PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesSettings settings)
                                         throws IOException
```
  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.
  
  Throws:
  
  IOException
- PrincipalAccessBoundaryPoliciesClient
```
protected PrincipalAccessBoundaryPoliciesClient(PrincipalAccessBoundaryPoliciesStub stub)
```

Method Detail

create

public static final PrincipalAccessBoundaryPoliciesClient create()
                                                          throws IOException

Constructs an instance of PrincipalAccessBoundaryPoliciesClient with default settings.

Throws:: IOException

create
```
public static final PrincipalAccessBoundaryPoliciesClient create(PrincipalAccessBoundaryPoliciesSettings settings)
                                                          throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final PrincipalAccessBoundaryPoliciesSettings getSettings()

getStub

public PrincipalAccessBoundaryPoliciesStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.