Class ResourcePoliciesClient (1.57.0)

GitHub RepositoryProduct Reference

Service Description: The ResourcePolicies API.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resourcePolicy = "resourcePolicy-130903328";
   ResourcePolicy response = resourcePoliciesClient.get(project, region, resourcePolicy);
 }

Note: close() needs to be called on the ResourcePoliciesClient 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

AggregatedList

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

  • aggregatedList(AggregatedListResourcePoliciesRequest request)

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

  • aggregatedList(String project)

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

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified resource policy.

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

  • deleteAsync(DeleteResourcePolicyRequest request)

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

  • deleteAsync(String project, String region, String resourcePolicy)

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

  • deleteOperationCallable()

  • deleteCallable()

Get

Retrieves all information of the specified resource policy.

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

  • get(GetResourcePolicyRequest request)

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

  • get(String project, String region, String resourcePolicy)

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

  • getCallable()

GetIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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

  • getIamPolicy(GetIamPolicyResourcePolicyRequest request)

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

  • getIamPolicy(String project, String region, String resource)

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

  • getIamPolicyCallable()

Insert

Creates a new resource policy.

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

  • insertAsync(InsertResourcePolicyRequest request)

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

  • insertAsync(String project, String region, ResourcePolicy resourcePolicyResource)

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

  • insertOperationCallable()

  • insertCallable()

List

A list all the resource policies that have been configured for the specified project in specified region.

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

  • list(ListResourcePoliciesRequest request)

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

  • list(String project, String region)

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

  • listPagedCallable()

  • listCallable()

Patch

Modify the specified resource policy.

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

  • patchAsync(PatchResourcePolicyRequest request)

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

  • patchAsync(String project, String region, String resourcePolicy, ResourcePolicy resourcePolicyResource)

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

  • patchOperationCallable()

  • patchCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

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

  • setIamPolicy(SetIamPolicyResourcePolicyRequest request)

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

  • setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

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

  • setIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource.

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

  • testIamPermissions(TestIamPermissionsResourcePolicyRequest request)

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

  • testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)

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

  • testIamPermissionsCallable()

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 ResourcePoliciesSettings 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
 ResourcePoliciesSettings resourcePoliciesSettings =
     ResourcePoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ResourcePoliciesClient resourcePoliciesClient =
     ResourcePoliciesClient.create(resourcePoliciesSettings);

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
 ResourcePoliciesSettings resourcePoliciesSettings =
     ResourcePoliciesSettings.newBuilder().setEndpoint(myEndpoint).build();
 ResourcePoliciesClient resourcePoliciesClient =
     ResourcePoliciesClient.create(resourcePoliciesSettings);

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

Inheritance

java.lang.Object > ResourcePoliciesClient

Static Methods

create()

public static final ResourcePoliciesClient create()

Constructs an instance of ResourcePoliciesClient with default settings.

Returns
Type Description
ResourcePoliciesClient
Exceptions
Type Description
IOException

create(ResourcePoliciesSettings settings)

public static final ResourcePoliciesClient create(ResourcePoliciesSettings settings)

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

Parameter
Name Description
settings ResourcePoliciesSettings
Returns
Type Description
ResourcePoliciesClient
Exceptions
Type Description
IOException

create(ResourcePoliciesStub stub)

public static final ResourcePoliciesClient create(ResourcePoliciesStub stub)

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

Parameter
Name Description
stub ResourcePoliciesStub
Returns
Type Description
ResourcePoliciesClient

Constructors

ResourcePoliciesClient(ResourcePoliciesSettings settings)

protected ResourcePoliciesClient(ResourcePoliciesSettings settings)

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

Parameter
Name Description
settings ResourcePoliciesSettings

ResourcePoliciesClient(ResourcePoliciesStub stub)

protected ResourcePoliciesClient(ResourcePoliciesStub stub)
Parameter
Name Description
stub ResourcePoliciesStub

Methods

aggregatedList(AggregatedListResourcePoliciesRequest request)

public final ResourcePoliciesClient.AggregatedListPagedResponse aggregatedList(AggregatedListResourcePoliciesRequest request)

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   AggregatedListResourcePoliciesRequest request =
       AggregatedListResourcePoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, ResourcePoliciesScopedList> element :
       resourcePoliciesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListResourcePoliciesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ResourcePoliciesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final ResourcePoliciesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, ResourcePoliciesScopedList> element :
       resourcePoliciesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
ResourcePoliciesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePolicyAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   AggregatedListResourcePoliciesRequest request =
       AggregatedListResourcePoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     ResourcePolicyAggregatedList response =
         resourcePoliciesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, ResourcePoliciesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePolicyAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePoliciesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   AggregatedListResourcePoliciesRequest request =
       AggregatedListResourcePoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, ResourcePoliciesScopedList>> future =
       resourcePoliciesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, ResourcePoliciesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListResourcePoliciesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

deleteAsync(DeleteResourcePolicyRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteResourcePolicyRequest request)

Deletes the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   DeleteResourcePolicyRequest request =
       DeleteResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicy("resourcePolicy-130903328")
           .build();
   Operation response = resourcePoliciesClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String resourcePolicy)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String resourcePolicy)

Deletes the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resourcePolicy = "resourcePolicy-130903328";
   Operation response =
       resourcePoliciesClient.deleteAsync(project, region, resourcePolicy).get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
resourcePolicy String

Name of the resource policy to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteResourcePolicyRequest,Operation> deleteCallable()

Deletes the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   DeleteResourcePolicyRequest request =
       DeleteResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicy("resourcePolicy-130903328")
           .build();
   ApiFuture<Operation> future = resourcePoliciesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteResourcePolicyRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteResourcePolicyRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   DeleteResourcePolicyRequest request =
       DeleteResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicy("resourcePolicy-130903328")
           .build();
   OperationFuture<Operation, Operation> future =
       resourcePoliciesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteResourcePolicyRequest,Operation,Operation>

get(GetResourcePolicyRequest request)

public final ResourcePolicy get(GetResourcePolicyRequest request)

Retrieves all information of the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   GetResourcePolicyRequest request =
       GetResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResourcePolicy("resourcePolicy-130903328")
           .build();
   ResourcePolicy response = resourcePoliciesClient.get(request);
 }
Parameter
Name Description
request GetResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ResourcePolicy

get(String project, String region, String resourcePolicy)

public final ResourcePolicy get(String project, String region, String resourcePolicy)

Retrieves all information of the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resourcePolicy = "resourcePolicy-130903328";
   ResourcePolicy response = resourcePoliciesClient.get(project, region, resourcePolicy);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
resourcePolicy String

Name of the resource policy to retrieve.
Returns
Type Description
ResourcePolicy

getCallable()

public final UnaryCallable<GetResourcePolicyRequest,ResourcePolicy> getCallable()

Retrieves all information of the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   GetResourcePolicyRequest request =
       GetResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResourcePolicy("resourcePolicy-130903328")
           .build();
   ApiFuture<ResourcePolicy> future = resourcePoliciesClient.getCallable().futureCall(request);
   // Do something.
   ResourcePolicy response = future.get();
 }
Returns
Type Description
UnaryCallable<GetResourcePolicyRequest,ResourcePolicy>

getIamPolicy(GetIamPolicyResourcePolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyResourcePolicyRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   GetIamPolicyResourcePolicyRequest request =
       GetIamPolicyResourcePolicyRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .build();
   Policy response = resourcePoliciesClient.getIamPolicy(request);
 }
Parameter
Name Description
request GetIamPolicyResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Policy

getIamPolicy(String project, String region, String resource)

public final Policy getIamPolicy(String project, String region, String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   Policy response = resourcePoliciesClient.getIamPolicy(project, region, resource);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

The name of the region for this request.
resource String

Name or id of the resource for this request.
Returns
Type Description
Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyResourcePolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   GetIamPolicyResourcePolicyRequest request =
       GetIamPolicyResourcePolicyRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = resourcePoliciesClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<GetIamPolicyResourcePolicyRequest,Policy>

getSettings()

public final ResourcePoliciesSettings getSettings()
Returns
Type Description
ResourcePoliciesSettings

getStub()

public ResourcePoliciesStub getStub()
Returns
Type Description
ResourcePoliciesStub

insertAsync(InsertResourcePolicyRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertResourcePolicyRequest request)

Creates a new resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   InsertResourcePolicyRequest request =
       InsertResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicyResource(ResourcePolicy.newBuilder().build())
           .build();
   Operation response = resourcePoliciesClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, ResourcePolicy resourcePolicyResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, ResourcePolicy resourcePolicyResource)

Creates a new resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   ResourcePolicy resourcePolicyResource = ResourcePolicy.newBuilder().build();
   Operation response =
       resourcePoliciesClient.insertAsync(project, region, resourcePolicyResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
resourcePolicyResource ResourcePolicy

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertResourcePolicyRequest,Operation> insertCallable()

Creates a new resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   InsertResourcePolicyRequest request =
       InsertResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicyResource(ResourcePolicy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = resourcePoliciesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertResourcePolicyRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertResourcePolicyRequest,Operation,Operation> insertOperationCallable()

Creates a new resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   InsertResourcePolicyRequest request =
       InsertResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicyResource(ResourcePolicy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       resourcePoliciesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertResourcePolicyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListResourcePoliciesRequest request)

public final ResourcePoliciesClient.ListPagedResponse list(ListResourcePoliciesRequest request)

A list all the resource policies that have been configured for the specified project in specified region.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   ListResourcePoliciesRequest request =
       ListResourcePoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (ResourcePolicy element : resourcePoliciesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListResourcePoliciesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ResourcePoliciesClient.ListPagedResponse

list(String project, String region)

public final ResourcePoliciesClient.ListPagedResponse list(String project, String region)

A list all the resource policies that have been configured for the specified project in specified region.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (ResourcePolicy element : resourcePoliciesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
Returns
Type Description
ResourcePoliciesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListResourcePoliciesRequest,ResourcePolicyList> listCallable()

A list all the resource policies that have been configured for the specified project in specified region.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   ListResourcePoliciesRequest request =
       ListResourcePoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ResourcePolicyList response = resourcePoliciesClient.listCallable().call(request);
     for (ResourcePolicy element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListResourcePoliciesRequest,ResourcePolicyList>

listPagedCallable()

public final UnaryCallable<ListResourcePoliciesRequest,ResourcePoliciesClient.ListPagedResponse> listPagedCallable()

A list all the resource policies that have been configured for the specified project in specified region.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   ListResourcePoliciesRequest request =
       ListResourcePoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<ResourcePolicy> future =
       resourcePoliciesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (ResourcePolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListResourcePoliciesRequest,ListPagedResponse>

patchAsync(PatchResourcePolicyRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchResourcePolicyRequest request)

Modify the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   PatchResourcePolicyRequest request =
       PatchResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicy("resourcePolicy-130903328")
           .setResourcePolicyResource(ResourcePolicy.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   Operation response = resourcePoliciesClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String resourcePolicy, ResourcePolicy resourcePolicyResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String resourcePolicy, ResourcePolicy resourcePolicyResource)

Modify the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resourcePolicy = "resourcePolicy-130903328";
   ResourcePolicy resourcePolicyResource = ResourcePolicy.newBuilder().build();
   Operation response =
       resourcePoliciesClient
           .patchAsync(project, region, resourcePolicy, resourcePolicyResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
resourcePolicy String

Id of the resource policy to patch.
resourcePolicyResource ResourcePolicy

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchResourcePolicyRequest,Operation> patchCallable()

Modify the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   PatchResourcePolicyRequest request =
       PatchResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicy("resourcePolicy-130903328")
           .setResourcePolicyResource(ResourcePolicy.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   ApiFuture<Operation> future = resourcePoliciesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchResourcePolicyRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchResourcePolicyRequest,Operation,Operation> patchOperationCallable()

Modify the specified resource policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   PatchResourcePolicyRequest request =
       PatchResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setResourcePolicy("resourcePolicy-130903328")
           .setResourcePolicyResource(ResourcePolicy.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   OperationFuture<Operation, Operation> future =
       resourcePoliciesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchResourcePolicyRequest,Operation,Operation>

setIamPolicy(SetIamPolicyResourcePolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyResourcePolicyRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   SetIamPolicyResourcePolicyRequest request =
       SetIamPolicyResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
           .setResource("resource-341064690")
           .build();
   Policy response = resourcePoliciesClient.setIamPolicy(request);
 }
Parameter
Name Description
request SetIamPolicyResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Policy

setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetPolicyRequest regionSetPolicyRequestResource =
       RegionSetPolicyRequest.newBuilder().build();
   Policy response =
       resourcePoliciesClient.setIamPolicy(
           project, region, resource, regionSetPolicyRequestResource);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

The name of the region for this request.
resource String

Name or id of the resource for this request.
regionSetPolicyRequestResource RegionSetPolicyRequest

The body resource for this request
Returns
Type Description
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyResourcePolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   SetIamPolicyResourcePolicyRequest request =
       SetIamPolicyResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = resourcePoliciesClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<SetIamPolicyResourcePolicyRequest,Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsResourcePolicyRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsResourcePolicyRequest request)

Returns permissions that a caller has on the specified resource.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   TestIamPermissionsResourcePolicyRequest request =
       TestIamPermissionsResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = resourcePoliciesClient.testIamPermissions(request);
 }
Parameter
Name Description
request TestIamPermissionsResourcePolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TestPermissionsResponse

testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       resourcePoliciesClient.testIamPermissions(
           project, region, resource, testPermissionsRequestResource);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

The name of the region for this request.
resource String

Name or id of the resource for this request.
testPermissionsRequestResource TestPermissionsRequest

The body resource for this request
Returns
Type Description
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsResourcePolicyRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

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 (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   TestIamPermissionsResourcePolicyRequest request =
       TestIamPermissionsResourcePolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       resourcePoliciesClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<TestIamPermissionsResourcePolicyRequest,TestPermissionsResponse>