Class ResourcePoliciesClient (1.9.1) 

public class ResourcePoliciesClient implements BackgroundResource

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:


 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().

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

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

See the individual methods for example code.

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

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

To customize credentials:


 ResourcePoliciesSettings resourcePoliciesSettings =
     ResourcePoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ResourcePoliciesClient resourcePoliciesClient =
     ResourcePoliciesClient.create(resourcePoliciesSettings);

To customize the endpoint:


 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

Implements

BackgroundResource

Static Methods

create()

public static final ResourcePoliciesClient create()

Constructs an instance of ResourcePoliciesClient with default settings.

Returns
TypeDescription
ResourcePoliciesClient
Exceptions
TypeDescription
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
NameDescription
settingsResourcePoliciesSettings
Returns
TypeDescription
ResourcePoliciesClient
Exceptions
TypeDescription
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
NameDescription
stubResourcePoliciesStub
Returns
TypeDescription
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
NameDescription
settingsResourcePoliciesSettings

ResourcePoliciesClient(ResourcePoliciesStub stub)

protected ResourcePoliciesClient(ResourcePoliciesStub stub)
Parameter
NameDescription
stubResourcePoliciesStub

Methods

aggregatedList(AggregatedListResourcePoliciesRequest request)

public final ResourcePoliciesClient.AggregatedListPagedResponse aggregatedList(AggregatedListResourcePoliciesRequest request)

Retrieves an aggregated list of resource policies.

Sample code:


 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)
           .build();
   for (Map.Entry<String, ResourcePoliciesScopedList> element :
       resourcePoliciesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
requestAggregatedListResourcePoliciesRequest

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

Returns
TypeDescription
ResourcePoliciesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final ResourcePoliciesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of resource policies.

Sample code:


 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, ResourcePoliciesScopedList> element :
       resourcePoliciesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
ResourcePoliciesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePolicyAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of resource policies.

Sample code:


 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)
           .build();
   while (true) {
     ResourcePolicyAggregatedList response =
         resourcePoliciesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, ResourcePoliciesScopedList> element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePolicyAggregatedList>

aggregatedListPagedCallable()

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

Retrieves an aggregated list of resource policies.

Sample code:


 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)
           .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
TypeDescription
UnaryCallable<AggregatedListResourcePoliciesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

deleteAsync(DeleteResourcePolicyRequest request)

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

Deletes the specified resource policy.

Sample code:


 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
NameDescription
requestDeleteResourcePolicyRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

resourcePolicyString

Name of the resource policy to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteResourcePolicyRequest,Operation> deleteCallable()

Deletes the specified resource policy.

Sample code:


 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
TypeDescription
UnaryCallable<DeleteResourcePolicyRequest,Operation>

deleteOperationCallable()

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

Deletes the specified resource policy.

Sample code:


 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
TypeDescription
OperationCallable<DeleteResourcePolicyRequest,Operation,Operation>

get(GetResourcePolicyRequest request)

public final ResourcePolicy get(GetResourcePolicyRequest request)

Retrieves all information of the specified resource policy.

Sample code:


 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
NameDescription
requestGetResourcePolicyRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

resourcePolicyString

Name of the resource policy to retrieve.

Returns
TypeDescription
ResourcePolicy

getCallable()

public final UnaryCallable<GetResourcePolicyRequest,ResourcePolicy> getCallable()

Retrieves all information of the specified resource policy.

Sample code:


 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
TypeDescription
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:


 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
NameDescription
requestGetIamPolicyResourcePolicyRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

The name of the region for this request.

resourceString

Name or id of the resource for this request.

Returns
TypeDescription
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:


 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
TypeDescription
UnaryCallable<GetIamPolicyResourcePolicyRequest,Policy>

getSettings()

public final ResourcePoliciesSettings getSettings()
Returns
TypeDescription
ResourcePoliciesSettings

getStub()

public ResourcePoliciesStub getStub()
Returns
TypeDescription
ResourcePoliciesStub

insertAsync(InsertResourcePolicyRequest request)

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

Creates a new resource policy.

Sample code:


 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
NameDescription
requestInsertResourcePolicyRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

resourcePolicyResourceResourcePolicy

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertResourcePolicyRequest,Operation> insertCallable()

Creates a new resource policy.

Sample code:


 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
TypeDescription
UnaryCallable<InsertResourcePolicyRequest,Operation>

insertOperationCallable()

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

Creates a new resource policy.

Sample code:


 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
TypeDescription
OperationCallable<InsertResourcePolicyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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:


 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
NameDescription
requestListResourcePoliciesRequest

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

Returns
TypeDescription
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:


 try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (ResourcePolicy element : resourcePoliciesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

Returns
TypeDescription
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:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
TypeDescription
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:


 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
TypeDescription
UnaryCallable<ListResourcePoliciesRequest,ListPagedResponse>

setIamPolicy(SetIamPolicyResourcePolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyResourcePolicyRequest request)

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

Sample code:


 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
NameDescription
requestSetIamPolicyResourcePolicyRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

The name of the region for this request.

resourceString

Name or id of the resource for this request.

regionSetPolicyRequestResourceRegionSetPolicyRequest

The body resource for this request

Returns
TypeDescription
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyResourcePolicyRequest,Policy> setIamPolicyCallable()

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

Sample code:


 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
TypeDescription
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:


 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
NameDescription
requestTestIamPermissionsResourcePolicyRequest

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

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

regionString

The name of the region for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

Returns
TypeDescription
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsResourcePolicyRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

Sample code:


 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
TypeDescription
UnaryCallable<TestIamPermissionsResourcePolicyRequest,TestPermissionsResponse>