PolicyBindingsClient (Google IAM Policy 1.61.0 API)

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

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

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

Service Description: An interface for managing Identity and Access Management (IAM) policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   PolicyBindingName name =
       PolicyBindingName.ofProjectLocationPolicyBindingName(
           "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]");
   PolicyBinding response = policyBindingsClient.getPolicyBinding(name);
 }

Note: close() needs to be called on the PolicyBindingsClient 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
CreatePolicyBinding	Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createPolicyBindingAsync(CreatePolicyBindingRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createPolicyBindingAsync(FolderLocationName parent, PolicyBinding policyBinding, String policyBindingId) createPolicyBindingAsync(LocationName parent, PolicyBinding policyBinding, String policyBindingId) createPolicyBindingAsync(OrganizationLocationName parent, PolicyBinding policyBinding, String policyBindingId) createPolicyBindingAsync(String parent, PolicyBinding policyBinding, String policyBindingId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPolicyBindingOperationCallable() createPolicyBindingCallable()
GetPolicyBinding	Gets a policy binding.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPolicyBinding(GetPolicyBindingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPolicyBinding(PolicyBindingName name) getPolicyBinding(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. getPolicyBindingCallable()
UpdatePolicyBinding	Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updatePolicyBindingAsync(UpdatePolicyBindingRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updatePolicyBindingAsync(PolicyBinding policyBinding, 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. updatePolicyBindingOperationCallable() updatePolicyBindingCallable()
DeletePolicyBinding	Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is deleted, the policy no longer applies to the target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePolicyBindingAsync(DeletePolicyBindingRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deletePolicyBindingAsync(PolicyBindingName name) deletePolicyBindingAsync(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. deletePolicyBindingOperationCallable() deletePolicyBindingCallable()
ListPolicyBindings	Lists policy bindings.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPolicyBindings(ListPolicyBindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPolicyBindings(FolderLocationName parent) listPolicyBindings(LocationName parent) listPolicyBindings(OrganizationLocationName parent) listPolicyBindings(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. listPolicyBindingsPagedCallable() listPolicyBindingsCallable()
SearchTargetPolicyBindings	Search policy bindings by target. Returns all policy binding objects bound directly to target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. searchTargetPolicyBindings(SearchTargetPolicyBindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. searchTargetPolicyBindings(FolderLocationName parent, String target) searchTargetPolicyBindings(LocationName parent, String target) searchTargetPolicyBindings(OrganizationLocationName parent, String target) searchTargetPolicyBindings(String parent, String target) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchTargetPolicyBindingsPagedCallable() searchTargetPolicyBindingsCallable()

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 PolicyBindingsSettings 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
 PolicyBindingsSettings policyBindingsSettings =
     PolicyBindingsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create(policyBindingsSettings);

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
 PolicyBindingsSettings policyBindingsSettings =
     PolicyBindingsSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create(policyBindingsSettings);

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
 PolicyBindingsSettings policyBindingsSettings =
     PolicyBindingsSettings.newHttpJsonBuilder().build();
 PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create(policyBindingsSettings);

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`	`PolicyBindingsClient.ListPolicyBindingsFixedSizeCollection`
`static class`	`PolicyBindingsClient.ListPolicyBindingsPage`
`static class`	`PolicyBindingsClient.ListPolicyBindingsPagedResponse`
`static class`	`PolicyBindingsClient.SearchTargetPolicyBindingsFixedSizeCollection`
`static class`	`PolicyBindingsClient.SearchTargetPolicyBindingsPage`
`static class`	`PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PolicyBindingsClient(PolicyBindingsSettings settings)` Constructs an instance of PolicyBindingsClient, using the given settings.
`protected`	`PolicyBindingsClient(PolicyBindingsStub 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 PolicyBindingsClient`	`create()` Constructs an instance of PolicyBindingsClient with default settings.
`static PolicyBindingsClient`	`create(PolicyBindingsSettings settings)` Constructs an instance of PolicyBindingsClient, using the given settings.
`static PolicyBindingsClient`	`create(PolicyBindingsStub stub)` Constructs an instance of PolicyBindingsClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`createPolicyBindingAsync(com.google.iam.v3beta.CreatePolicyBindingRequest request)` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`createPolicyBindingAsync(com.google.iam.v3beta.FolderLocationName parent, com.google.iam.v3beta.PolicyBinding policyBinding, String policyBindingId)` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`createPolicyBindingAsync(com.google.iam.v3beta.LocationName parent, com.google.iam.v3beta.PolicyBinding policyBinding, String policyBindingId)` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`createPolicyBindingAsync(com.google.iam.v3beta.OrganizationLocationName parent, com.google.iam.v3beta.PolicyBinding policyBinding, String policyBindingId)` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`createPolicyBindingAsync(String parent, com.google.iam.v3beta.PolicyBinding policyBinding, String policyBindingId)` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.CreatePolicyBindingRequest,com.google.longrunning.Operation>`	`createPolicyBindingCallable()` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.CreatePolicyBindingRequest,com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`createPolicyBindingOperationCallable()` Creates a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePolicyBindingAsync(com.google.iam.v3beta.DeletePolicyBindingRequest request)` Deletes a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePolicyBindingAsync(com.google.iam.v3beta.PolicyBindingName name)` Deletes a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePolicyBindingAsync(String name)` Deletes a policy binding and returns a long-running operation.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.DeletePolicyBindingRequest,com.google.longrunning.Operation>`	`deletePolicyBindingCallable()` Deletes a policy binding and returns a long-running operation.
`com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.DeletePolicyBindingRequest,com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata>`	`deletePolicyBindingOperationCallable()` Deletes a policy binding and returns a long-running operation.
`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.PolicyBinding`	`getPolicyBinding(com.google.iam.v3beta.GetPolicyBindingRequest request)` Gets a policy binding.
`com.google.iam.v3beta.PolicyBinding`	`getPolicyBinding(com.google.iam.v3beta.PolicyBindingName name)` Gets a policy binding.
`com.google.iam.v3beta.PolicyBinding`	`getPolicyBinding(String name)` Gets a policy binding.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.GetPolicyBindingRequest,com.google.iam.v3beta.PolicyBinding>`	`getPolicyBindingCallable()` Gets a policy binding.
`PolicyBindingsSettings`	`getSettings()`
`PolicyBindingsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PolicyBindingsClient.ListPolicyBindingsPagedResponse`	`listPolicyBindings(com.google.iam.v3beta.FolderLocationName parent)` Lists policy bindings.
`PolicyBindingsClient.ListPolicyBindingsPagedResponse`	`listPolicyBindings(com.google.iam.v3beta.ListPolicyBindingsRequest request)` Lists policy bindings.
`PolicyBindingsClient.ListPolicyBindingsPagedResponse`	`listPolicyBindings(com.google.iam.v3beta.LocationName parent)` Lists policy bindings.
`PolicyBindingsClient.ListPolicyBindingsPagedResponse`	`listPolicyBindings(com.google.iam.v3beta.OrganizationLocationName parent)` Lists policy bindings.
`PolicyBindingsClient.ListPolicyBindingsPagedResponse`	`listPolicyBindings(String parent)` Lists policy bindings.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.ListPolicyBindingsRequest,com.google.iam.v3beta.ListPolicyBindingsResponse>`	`listPolicyBindingsCallable()` Lists policy bindings.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.ListPolicyBindingsRequest,PolicyBindingsClient.ListPolicyBindingsPagedResponse>`	`listPolicyBindingsPagedCallable()` Lists policy bindings.
`PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse`	`searchTargetPolicyBindings(com.google.iam.v3beta.FolderLocationName parent, String target)` Search policy bindings by target.
`PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse`	`searchTargetPolicyBindings(com.google.iam.v3beta.LocationName parent, String target)` Search policy bindings by target.
`PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse`	`searchTargetPolicyBindings(com.google.iam.v3beta.OrganizationLocationName parent, String target)` Search policy bindings by target.
`PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse`	`searchTargetPolicyBindings(com.google.iam.v3beta.SearchTargetPolicyBindingsRequest request)` Search policy bindings by target.
`PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse`	`searchTargetPolicyBindings(String parent, String target)` Search policy bindings by target.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.SearchTargetPolicyBindingsRequest,com.google.iam.v3beta.SearchTargetPolicyBindingsResponse>`	`searchTargetPolicyBindingsCallable()` Search policy bindings by target.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.SearchTargetPolicyBindingsRequest,PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse>`	`searchTargetPolicyBindingsPagedCallable()` Search policy bindings by target.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`updatePolicyBindingAsync(com.google.iam.v3beta.PolicyBinding policyBinding, com.google.protobuf.FieldMask updateMask)` Updates a policy binding and returns a long-running operation.
`com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`updatePolicyBindingAsync(com.google.iam.v3beta.UpdatePolicyBindingRequest request)` Updates a policy binding and returns a long-running operation.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.UpdatePolicyBindingRequest,com.google.longrunning.Operation>`	`updatePolicyBindingCallable()` Updates a policy binding and returns a long-running operation.
`com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.UpdatePolicyBindingRequest,com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata>`	`updatePolicyBindingOperationCallable()` Updates a policy binding and returns a long-running operation.

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

Constructor Detail
- PolicyBindingsClient
```
protected PolicyBindingsClient(PolicyBindingsSettings settings)
                        throws IOException
```
  Constructs an instance of PolicyBindingsClient, 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
- PolicyBindingsClient
```
protected PolicyBindingsClient(PolicyBindingsStub stub)
```

Method Detail

create

public static final PolicyBindingsClient create()
                                         throws IOException

Constructs an instance of PolicyBindingsClient with default settings.

Throws:: IOException

create
```
public static final PolicyBindingsClient create(PolicyBindingsSettings settings)
                                         throws IOException
```
Constructs an instance of PolicyBindingsClient, 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 PolicyBindingsClient create(PolicyBindingsStub stub)
```
Constructs an instance of PolicyBindingsClient, using the given stub for making calls. This is for advanced usage - prefer using create(PolicyBindingsSettings).

getSettings

public final PolicyBindingsSettings getSettings()

getStub
```
public PolicyBindingsStub 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.

createPolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> createPolicyBindingAsync(com.google.iam.v3beta.FolderLocationName parent,
                                                                                                                                                                  com.google.iam.v3beta.PolicyBinding policyBinding,
                                                                                                                                                                  String policyBindingId)

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   FolderLocationName parent = FolderLocationName.of("[FOLDER]", "[LOCATION]");
   PolicyBinding policyBinding = PolicyBinding.newBuilder().build();
   String policyBindingId = "policyBindingId1375821166";
   PolicyBinding response =
       policyBindingsClient
           .createPolicyBindingAsync(parent, policyBinding, policyBindingId)
           .get();
 }

Parameters:

parent - Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

policyBinding - Required. The policy binding to create.

policyBindingId - Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> createPolicyBindingAsync(com.google.iam.v3beta.LocationName parent,
                                                                                                                                                                  com.google.iam.v3beta.PolicyBinding policyBinding,
                                                                                                                                                                  String policyBindingId)

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PolicyBinding policyBinding = PolicyBinding.newBuilder().build();
   String policyBindingId = "policyBindingId1375821166";
   PolicyBinding response =
       policyBindingsClient
           .createPolicyBindingAsync(parent, policyBinding, policyBindingId)
           .get();
 }

Parameters:

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

policyBinding - Required. The policy binding to create.

policyBindingId - Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> createPolicyBindingAsync(com.google.iam.v3beta.OrganizationLocationName parent,
                                                                                                                                                                  com.google.iam.v3beta.PolicyBinding policyBinding,
                                                                                                                                                                  String policyBindingId)

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   PolicyBinding policyBinding = PolicyBinding.newBuilder().build();
   String policyBindingId = "policyBindingId1375821166";
   PolicyBinding response =
       policyBindingsClient
           .createPolicyBindingAsync(parent, policyBinding, policyBindingId)
           .get();
 }

Parameters:

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

policyBinding - Required. The policy binding to create.

policyBindingId - Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> createPolicyBindingAsync(String parent,
                                                                                                                                                                  com.google.iam.v3beta.PolicyBinding policyBinding,
                                                                                                                                                                  String policyBindingId)

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   PolicyBinding policyBinding = PolicyBinding.newBuilder().build();
   String policyBindingId = "policyBindingId1375821166";
   PolicyBinding response =
       policyBindingsClient
           .createPolicyBindingAsync(parent, policyBinding, policyBindingId)
           .get();
 }

Parameters:

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

policyBinding - Required. The policy binding to create.

policyBindingId - Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> createPolicyBindingAsync(com.google.iam.v3beta.CreatePolicyBindingRequest request)

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   CreatePolicyBindingRequest request =
       CreatePolicyBindingRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPolicyBindingId("policyBindingId1375821166")
           .setPolicyBinding(PolicyBinding.newBuilder().build())
           .setValidateOnly(true)
           .build();
   PolicyBinding response = policyBindingsClient.createPolicyBindingAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPolicyBindingOperationCallable

public final com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.CreatePolicyBindingRequest,com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> createPolicyBindingOperationCallable()

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   CreatePolicyBindingRequest request =
       CreatePolicyBindingRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPolicyBindingId("policyBindingId1375821166")
           .setPolicyBinding(PolicyBinding.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<PolicyBinding, OperationMetadata> future =
       policyBindingsClient.createPolicyBindingOperationCallable().futureCall(request);
   // Do something.
   PolicyBinding response = future.get();
 }

createPolicyBindingCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.CreatePolicyBindingRequest,com.google.longrunning.Operation> createPolicyBindingCallable()

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   CreatePolicyBindingRequest request =
       CreatePolicyBindingRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPolicyBindingId("policyBindingId1375821166")
           .setPolicyBinding(PolicyBinding.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       policyBindingsClient.createPolicyBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

getPolicyBinding

public final com.google.iam.v3beta.PolicyBinding getPolicyBinding(com.google.iam.v3beta.PolicyBindingName name)

Gets a policy binding.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   PolicyBindingName name =
       PolicyBindingName.ofProjectLocationPolicyBindingName(
           "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]");
   PolicyBinding response = policyBindingsClient.getPolicyBinding(name);
 }

Parameters:

name - Required. The name of the policy binding to retrieve.

Format:

`projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}`
`projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}`
`folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}`
`organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getPolicyBinding

public final com.google.iam.v3beta.PolicyBinding getPolicyBinding(String name)

Gets a policy binding.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   String name =
       PolicyBindingName.ofOrganizationLocationPolicyBindingName(
               "[ORGANIZATION]", "[LOCATION]", "[POLICY_BINDING]")
           .toString();
   PolicyBinding response = policyBindingsClient.getPolicyBinding(name);
 }

Parameters:

name - Required. The name of the policy binding to retrieve.

Format:

`projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}`
`projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}`
`folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}`
`organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getPolicyBinding

public final com.google.iam.v3beta.PolicyBinding getPolicyBinding(com.google.iam.v3beta.GetPolicyBindingRequest request)

Gets a policy binding.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   GetPolicyBindingRequest request =
       GetPolicyBindingRequest.newBuilder()
           .setName(
               PolicyBindingName.ofProjectLocationPolicyBindingName(
                       "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]")
                   .toString())
           .build();
   PolicyBinding response = policyBindingsClient.getPolicyBinding(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getPolicyBindingCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.GetPolicyBindingRequest,com.google.iam.v3beta.PolicyBinding> getPolicyBindingCallable()

Gets a policy binding.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   GetPolicyBindingRequest request =
       GetPolicyBindingRequest.newBuilder()
           .setName(
               PolicyBindingName.ofProjectLocationPolicyBindingName(
                       "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]")
                   .toString())
           .build();
   ApiFuture<PolicyBinding> future =
       policyBindingsClient.getPolicyBindingCallable().futureCall(request);
   // Do something.
   PolicyBinding response = future.get();
 }

updatePolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> updatePolicyBindingAsync(com.google.iam.v3beta.PolicyBinding policyBinding,
                                                                                                                                                                  com.google.protobuf.FieldMask updateMask)

Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   PolicyBinding policyBinding = PolicyBinding.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PolicyBinding response =
       policyBindingsClient.updatePolicyBindingAsync(policyBinding, updateMask).get();
 }

Parameters:: policyBinding - Required. The policy binding to update.
The policy binding's `name` field is used to identify the policy binding to update.; updateMask - Optional. The list of fields to update
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updatePolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> updatePolicyBindingAsync(com.google.iam.v3beta.UpdatePolicyBindingRequest request)

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   UpdatePolicyBindingRequest request =
       UpdatePolicyBindingRequest.newBuilder()
           .setPolicyBinding(PolicyBinding.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PolicyBinding response = policyBindingsClient.updatePolicyBindingAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updatePolicyBindingOperationCallable

public final com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.UpdatePolicyBindingRequest,com.google.iam.v3beta.PolicyBinding,com.google.iam.v3beta.OperationMetadata> updatePolicyBindingOperationCallable()

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   UpdatePolicyBindingRequest request =
       UpdatePolicyBindingRequest.newBuilder()
           .setPolicyBinding(PolicyBinding.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<PolicyBinding, OperationMetadata> future =
       policyBindingsClient.updatePolicyBindingOperationCallable().futureCall(request);
   // Do something.
   PolicyBinding response = future.get();
 }

updatePolicyBindingCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.UpdatePolicyBindingRequest,com.google.longrunning.Operation> updatePolicyBindingCallable()

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   UpdatePolicyBindingRequest request =
       UpdatePolicyBindingRequest.newBuilder()
           .setPolicyBinding(PolicyBinding.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       policyBindingsClient.updatePolicyBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deletePolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata> deletePolicyBindingAsync(com.google.iam.v3beta.PolicyBindingName name)

Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is deleted, the policy no longer applies to the target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   PolicyBindingName name =
       PolicyBindingName.ofProjectLocationPolicyBindingName(
           "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]");
   policyBindingsClient.deletePolicyBindingAsync(name).get();
 }

Parameters:

name - Required. The name of the policy binding to delete.

Format:

`projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}`
`projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}`
`folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}`
`organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deletePolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata> deletePolicyBindingAsync(String 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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   String name =
       PolicyBindingName.ofOrganizationLocationPolicyBindingName(
               "[ORGANIZATION]", "[LOCATION]", "[POLICY_BINDING]")
           .toString();
   policyBindingsClient.deletePolicyBindingAsync(name).get();
 }

Parameters:

name - Required. The name of the policy binding to delete.

Format:

`projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}`
`projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}`
`folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}`
`organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deletePolicyBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata> deletePolicyBindingAsync(com.google.iam.v3beta.DeletePolicyBindingRequest request)

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   DeletePolicyBindingRequest request =
       DeletePolicyBindingRequest.newBuilder()
           .setName(
               PolicyBindingName.ofProjectLocationPolicyBindingName(
                       "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]")
                   .toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .build();
   policyBindingsClient.deletePolicyBindingAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deletePolicyBindingOperationCallable

public final com.google.api.gax.rpc.OperationCallable<com.google.iam.v3beta.DeletePolicyBindingRequest,com.google.protobuf.Empty,com.google.iam.v3beta.OperationMetadata> deletePolicyBindingOperationCallable()

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   DeletePolicyBindingRequest request =
       DeletePolicyBindingRequest.newBuilder()
           .setName(
               PolicyBindingName.ofProjectLocationPolicyBindingName(
                       "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]")
                   .toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       policyBindingsClient.deletePolicyBindingOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

deletePolicyBindingCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.DeletePolicyBindingRequest,com.google.longrunning.Operation> deletePolicyBindingCallable()

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   DeletePolicyBindingRequest request =
       DeletePolicyBindingRequest.newBuilder()
           .setName(
               PolicyBindingName.ofProjectLocationPolicyBindingName(
                       "[PROJECT]", "[LOCATION]", "[POLICY_BINDING]")
                   .toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       policyBindingsClient.deletePolicyBindingCallable().futureCall(request);
   // Do something.
   future.get();
 }

listPolicyBindings

public final PolicyBindingsClient.ListPolicyBindingsPagedResponse listPolicyBindings(com.google.iam.v3beta.FolderLocationName parent)

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   FolderLocationName parent = FolderLocationName.of("[FOLDER]", "[LOCATION]");
   for (PolicyBinding element : policyBindingsClient.listPolicyBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource, which owns the collection of policy bindings.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPolicyBindings

public final PolicyBindingsClient.ListPolicyBindingsPagedResponse listPolicyBindings(com.google.iam.v3beta.LocationName parent)

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PolicyBinding element : policyBindingsClient.listPolicyBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource, which owns the collection of policy bindings.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPolicyBindings

public final PolicyBindingsClient.ListPolicyBindingsPagedResponse listPolicyBindings(com.google.iam.v3beta.OrganizationLocationName parent)

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (PolicyBinding element : policyBindingsClient.listPolicyBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource, which owns the collection of policy bindings.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPolicyBindings

public final PolicyBindingsClient.ListPolicyBindingsPagedResponse listPolicyBindings(String parent)

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (PolicyBinding element : policyBindingsClient.listPolicyBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource, which owns the collection of policy bindings.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPolicyBindings

public final PolicyBindingsClient.ListPolicyBindingsPagedResponse listPolicyBindings(com.google.iam.v3beta.ListPolicyBindingsRequest request)

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   ListPolicyBindingsRequest request =
       ListPolicyBindingsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (PolicyBinding element : policyBindingsClient.listPolicyBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listPolicyBindingsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.ListPolicyBindingsRequest,PolicyBindingsClient.ListPolicyBindingsPagedResponse> listPolicyBindingsPagedCallable()

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   ListPolicyBindingsRequest request =
       ListPolicyBindingsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<PolicyBinding> future =
       policyBindingsClient.listPolicyBindingsPagedCallable().futureCall(request);
   // Do something.
   for (PolicyBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listPolicyBindingsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.ListPolicyBindingsRequest,com.google.iam.v3beta.ListPolicyBindingsResponse> listPolicyBindingsCallable()

Lists policy bindings.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   ListPolicyBindingsRequest request =
       ListPolicyBindingsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListPolicyBindingsResponse response =
         policyBindingsClient.listPolicyBindingsCallable().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;
     }
   }
 }

searchTargetPolicyBindings

public final PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse searchTargetPolicyBindings(com.google.iam.v3beta.FolderLocationName parent,
                                                                                                     String target)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   FolderLocationName parent = FolderLocationName.of("[FOLDER]", "[LOCATION]");
   String target = "target-880905839";
   for (PolicyBinding element :
       policyBindingsClient.searchTargetPolicyBindings(parent, target).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

target - Required. The target resource, which is bound to the policy in the binding.

Format:

`//iam.googleapis.com/locations/global/workforcePools/POOL_ID`
`//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID`
`//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID`
`//cloudresourcemanager.googleapis.com/projects/{project_number}`
`//cloudresourcemanager.googleapis.com/folders/{folder_id}`
`//cloudresourcemanager.googleapis.com/organizations/{organization_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchTargetPolicyBindings

public final PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse searchTargetPolicyBindings(com.google.iam.v3beta.LocationName parent,
                                                                                                     String target)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String target = "target-880905839";
   for (PolicyBinding element :
       policyBindingsClient.searchTargetPolicyBindings(parent, target).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

target - Required. The target resource, which is bound to the policy in the binding.

Format:

`//iam.googleapis.com/locations/global/workforcePools/POOL_ID`
`//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID`
`//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID`
`//cloudresourcemanager.googleapis.com/projects/{project_number}`
`//cloudresourcemanager.googleapis.com/folders/{folder_id}`
`//cloudresourcemanager.googleapis.com/organizations/{organization_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchTargetPolicyBindings

public final PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse searchTargetPolicyBindings(com.google.iam.v3beta.OrganizationLocationName parent,
                                                                                                     String target)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   String target = "target-880905839";
   for (PolicyBinding element :
       policyBindingsClient.searchTargetPolicyBindings(parent, target).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

target - Required. The target resource, which is bound to the policy in the binding.

Format:

`//iam.googleapis.com/locations/global/workforcePools/POOL_ID`
`//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID`
`//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID`
`//cloudresourcemanager.googleapis.com/projects/{project_number}`
`//cloudresourcemanager.googleapis.com/folders/{folder_id}`
`//cloudresourcemanager.googleapis.com/organizations/{organization_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchTargetPolicyBindings

public final PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse searchTargetPolicyBindings(String parent,
                                                                                                     String target)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   String target = "target-880905839";
   for (PolicyBinding element :
       policyBindingsClient.searchTargetPolicyBindings(parent, target).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

parent - Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

`projects/{project_id}/locations/{location}`
`projects/{project_number}/locations/{location}`
`folders/{folder_id}/locations/{location}`
`organizations/{organization_id}/locations/{location}`

target - Required. The target resource, which is bound to the policy in the binding.

Format:

`//iam.googleapis.com/locations/global/workforcePools/POOL_ID`
`//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID`
`//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID`
`//cloudresourcemanager.googleapis.com/projects/{project_number}`
`//cloudresourcemanager.googleapis.com/folders/{folder_id}`
`//cloudresourcemanager.googleapis.com/organizations/{organization_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchTargetPolicyBindings

public final PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse searchTargetPolicyBindings(com.google.iam.v3beta.SearchTargetPolicyBindingsRequest request)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   SearchTargetPolicyBindingsRequest request =
       SearchTargetPolicyBindingsRequest.newBuilder()
           .setTarget("target-880905839")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .build();
   for (PolicyBinding element :
       policyBindingsClient.searchTargetPolicyBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchTargetPolicyBindingsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.SearchTargetPolicyBindingsRequest,PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse> searchTargetPolicyBindingsPagedCallable()

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   SearchTargetPolicyBindingsRequest request =
       SearchTargetPolicyBindingsRequest.newBuilder()
           .setTarget("target-880905839")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .build();
   ApiFuture<PolicyBinding> future =
       policyBindingsClient.searchTargetPolicyBindingsPagedCallable().futureCall(request);
   // Do something.
   for (PolicyBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

searchTargetPolicyBindingsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v3beta.SearchTargetPolicyBindingsRequest,com.google.iam.v3beta.SearchTargetPolicyBindingsResponse> searchTargetPolicyBindingsCallable()

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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 (PolicyBindingsClient policyBindingsClient = PolicyBindingsClient.create()) {
   SearchTargetPolicyBindingsRequest request =
       SearchTargetPolicyBindingsRequest.newBuilder()
           .setTarget("target-880905839")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .build();
   while (true) {
     SearchTargetPolicyBindingsResponse response =
         policyBindingsClient.searchTargetPolicyBindingsCallable().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;
     }
   }
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class PolicyBindingsClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolicyBindingsClient

PolicyBindingsClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

createPolicyBindingAsync

createPolicyBindingAsync

createPolicyBindingAsync

createPolicyBindingAsync

createPolicyBindingAsync

createPolicyBindingOperationCallable

createPolicyBindingCallable

getPolicyBinding

getPolicyBinding

getPolicyBinding

getPolicyBindingCallable

updatePolicyBindingAsync

updatePolicyBindingAsync

updatePolicyBindingOperationCallable

updatePolicyBindingCallable

deletePolicyBindingAsync

deletePolicyBindingAsync

deletePolicyBindingAsync

deletePolicyBindingOperationCallable

deletePolicyBindingCallable

listPolicyBindings

listPolicyBindings

listPolicyBindings

listPolicyBindings

listPolicyBindings

listPolicyBindingsPagedCallable

listPolicyBindingsCallable

searchTargetPolicyBindings

searchTargetPolicyBindings

searchTargetPolicyBindings

searchTargetPolicyBindings

searchTargetPolicyBindings

searchTargetPolicyBindingsPagedCallable

searchTargetPolicyBindingsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination