com.google.cloud.compute.v1

Class ResourcePolicyClient

java.lang.Object

com.google.cloud.compute.v1.ResourcePolicyClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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 (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyName resourcePolicy = ProjectRegionResourcePolicyName.of("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   Operation response = resourcePolicyClient.deleteResourcePolicy(resourcePolicy);
 }
 
 

Note: close() needs to be called on the resourcePolicyClient 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 ResourcePolicySettings to create(). For example:

To customize credentials:

 
 ResourcePolicySettings resourcePolicySettings =
     ResourcePolicySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ResourcePolicyClient resourcePolicyClient =
     ResourcePolicyClient.create(resourcePolicySettings);
 
 

To customize the endpoint:

 
 ResourcePolicySettings resourcePolicySettings =
     ResourcePolicySettings.newBuilder().setEndpoint(myEndpoint).build();
 ResourcePolicyClient resourcePolicyClient =
     ResourcePolicyClient.create(resourcePolicySettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourcePolicyClient.AggregatedListResourcePoliciesFixedSizeCollection
static class	ResourcePolicyClient.AggregatedListResourcePoliciesPage
static class	ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse
static class	ResourcePolicyClient.ListResourcePoliciesFixedSizeCollection
static class	ResourcePolicyClient.ListResourcePoliciesPage
static class	ResourcePolicyClient.ListResourcePoliciesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourcePolicyClient(ResourcePolicySettings settings) Constructs an instance of ResourcePolicyClient, using the given settings.
protected	ResourcePolicyClient(ResourcePolicyStub stub)

Method Summary

Modifier and Type	Method and Description
ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse	aggregatedListResourcePolicies(AggregatedListResourcePoliciesHttpRequest request) Retrieves an aggregated list of resource policies.
ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse	aggregatedListResourcePolicies(ProjectName project) Retrieves an aggregated list of resource policies.
ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse	aggregatedListResourcePolicies(String project) Retrieves an aggregated list of resource policies.
com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesHttpRequest,ResourcePolicyAggregatedList>	aggregatedListResourcePoliciesCallable() Retrieves an aggregated list of resource policies.
com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesHttpRequest,ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse>	aggregatedListResourcePoliciesPagedCallable() Retrieves an aggregated list of resource policies.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ResourcePolicyClient	create() Constructs an instance of ResourcePolicyClient with default settings.
static ResourcePolicyClient	create(ResourcePolicySettings settings) Constructs an instance of ResourcePolicyClient, using the given settings.
static ResourcePolicyClient	create(ResourcePolicyStub stub) Constructs an instance of ResourcePolicyClient, using the given stub for making calls.
Operation	deleteResourcePolicy(DeleteResourcePolicyHttpRequest request) Deletes the specified resource policy.
Operation	deleteResourcePolicy(ProjectRegionResourcePolicyName resourcePolicy) Deletes the specified resource policy.
Operation	deleteResourcePolicy(String resourcePolicy) Deletes the specified resource policy.
com.google.api.gax.rpc.UnaryCallable<DeleteResourcePolicyHttpRequest,Operation>	deleteResourcePolicyCallable() Deletes the specified resource policy.
Policy	getIamPolicyResourcePolicy(GetIamPolicyResourcePolicyHttpRequest request) Gets the access control policy for a resource.
Policy	getIamPolicyResourcePolicy(ProjectRegionResourcePolicyResourceName resource) Gets the access control policy for a resource.
Policy	getIamPolicyResourcePolicy(String resource) Gets the access control policy for a resource.
com.google.api.gax.rpc.UnaryCallable<GetIamPolicyResourcePolicyHttpRequest,Policy>	getIamPolicyResourcePolicyCallable() Gets the access control policy for a resource.
ResourcePolicy	getResourcePolicy(GetResourcePolicyHttpRequest request) Retrieves all information of the specified resource policy.
ResourcePolicy	getResourcePolicy(ProjectRegionResourcePolicyName resourcePolicy) Retrieves all information of the specified resource policy.
ResourcePolicy	getResourcePolicy(String resourcePolicy) Retrieves all information of the specified resource policy.
com.google.api.gax.rpc.UnaryCallable<GetResourcePolicyHttpRequest,ResourcePolicy>	getResourcePolicyCallable() Retrieves all information of the specified resource policy.
ResourcePolicySettings	getSettings()
ResourcePolicyStub	getStub()
Operation	insertResourcePolicy(InsertResourcePolicyHttpRequest request) Creates a new resource policy.
Operation	insertResourcePolicy(ProjectRegionName region, ResourcePolicy resourcePolicyResource) Creates a new resource policy.
Operation	insertResourcePolicy(String region, ResourcePolicy resourcePolicyResource) Creates a new resource policy.
com.google.api.gax.rpc.UnaryCallable<InsertResourcePolicyHttpRequest,Operation>	insertResourcePolicyCallable() Creates a new resource policy.
boolean	isShutdown()
boolean	isTerminated()
ResourcePolicyClient.ListResourcePoliciesPagedResponse	listResourcePolicies(ListResourcePoliciesHttpRequest request) A list all the resource policies that have been configured for the specified project in specified region.
ResourcePolicyClient.ListResourcePoliciesPagedResponse	listResourcePolicies(ProjectRegionName region) A list all the resource policies that have been configured for the specified project in specified region.
ResourcePolicyClient.ListResourcePoliciesPagedResponse	listResourcePolicies(String region) A list all the resource policies that have been configured for the specified project in specified region.
com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesHttpRequest,ResourcePolicyList>	listResourcePoliciesCallable() A list all the resource policies that have been configured for the specified project in specified region.
com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesHttpRequest,ResourcePolicyClient.ListResourcePoliciesPagedResponse>	listResourcePoliciesPagedCallable() A list all the resource policies that have been configured for the specified project in specified region.
Policy	setIamPolicyResourcePolicy(ProjectRegionResourcePolicyResourceName resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Sets the access control policy on the specified resource.
Policy	setIamPolicyResourcePolicy(SetIamPolicyResourcePolicyHttpRequest request) Sets the access control policy on the specified resource.
Policy	setIamPolicyResourcePolicy(String resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Sets the access control policy on the specified resource.
com.google.api.gax.rpc.UnaryCallable<SetIamPolicyResourcePolicyHttpRequest,Policy>	setIamPolicyResourcePolicyCallable() Sets the access control policy on the specified resource.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsResourcePolicy(ProjectRegionResourcePolicyResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsResourcePolicy(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsResourcePolicy(TestIamPermissionsResourcePolicyHttpRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsResourcePolicyHttpRequest,TestPermissionsResponse>	testIamPermissionsResourcePolicyCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourcePolicyClient

protected ResourcePolicyClient(ResourcePolicySettings settings)
                        throws IOException

Constructs an instance of ResourcePolicyClient, 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

ResourcePolicyClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ResourcePolicyClient(ResourcePolicyStub stub)

Method Detail

create

public static final ResourcePolicyClient create()
                                         throws IOException

Constructs an instance of ResourcePolicyClient with default settings.

Throws:

IOException

create

public static final ResourcePolicyClient create(ResourcePolicySettings settings)
                                         throws IOException

Constructs an instance of ResourcePolicyClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final ResourcePolicyClient create(ResourcePolicyStub stub)

Constructs an instance of ResourcePolicyClient, using the given stub for making calls. This is for advanced usage - prefer to use ResourcePolicySettings}.

getSettings

public final ResourcePolicySettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ResourcePolicyStub getStub()

aggregatedListResourcePolicies

@BetaApi
public final ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse aggregatedListResourcePolicies(ProjectName project)

Retrieves an aggregated list of resource policies.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (ResourcePoliciesScopedList element : resourcePolicyClient.aggregatedListResourcePolicies(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListResourcePolicies

@BetaApi
public final ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse aggregatedListResourcePolicies(String project)

Retrieves an aggregated list of resource policies.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (ResourcePoliciesScopedList element : resourcePolicyClient.aggregatedListResourcePolicies(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListResourcePolicies

@BetaApi
public final ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse aggregatedListResourcePolicies(AggregatedListResourcePoliciesHttpRequest request)

Retrieves an aggregated list of resource policies.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListResourcePoliciesHttpRequest request = AggregatedListResourcePoliciesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (ResourcePoliciesScopedList element : resourcePolicyClient.aggregatedListResourcePolicies(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

aggregatedListResourcePoliciesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesHttpRequest,ResourcePolicyClient.AggregatedListResourcePoliciesPagedResponse> aggregatedListResourcePoliciesPagedCallable()

Retrieves an aggregated list of resource policies.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListResourcePoliciesHttpRequest request = AggregatedListResourcePoliciesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListResourcePoliciesPagedResponse> future = resourcePolicyClient.aggregatedListResourcePoliciesPagedCallable().futureCall(request);
   // Do something
   for (ResourcePoliciesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListResourcePoliciesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesHttpRequest,ResourcePolicyAggregatedList> aggregatedListResourcePoliciesCallable()

Retrieves an aggregated list of resource policies.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListResourcePoliciesHttpRequest request = AggregatedListResourcePoliciesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     ResourcePolicyAggregatedList response = resourcePolicyClient.aggregatedListResourcePoliciesCallable().call(request);
     for (ResourcePoliciesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteResourcePolicy

@BetaApi
public final Operation deleteResourcePolicy(ProjectRegionResourcePolicyName resourcePolicy)

Deletes the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyName resourcePolicy = ProjectRegionResourcePolicyName.of("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   Operation response = resourcePolicyClient.deleteResourcePolicy(resourcePolicy);
 }
 

Parameters:

resourcePolicy - Name of the resource policy to delete.

Throws:

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

deleteResourcePolicy

@BetaApi
public final Operation deleteResourcePolicy(String resourcePolicy)

Deletes the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyName resourcePolicy = ProjectRegionResourcePolicyName.of("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   Operation response = resourcePolicyClient.deleteResourcePolicy(resourcePolicy.toString());
 }
 

Parameters:

resourcePolicy - Name of the resource policy to delete.

Throws:

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

deleteResourcePolicy

@BetaApi
public final Operation deleteResourcePolicy(DeleteResourcePolicyHttpRequest request)

Deletes the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResourcePolicy = ProjectRegionResourcePolicyName.format("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   DeleteResourcePolicyHttpRequest request = DeleteResourcePolicyHttpRequest.newBuilder()
     .setResourcePolicy(formattedResourcePolicy)
     .build();
   Operation response = resourcePolicyClient.deleteResourcePolicy(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

deleteResourcePolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteResourcePolicyHttpRequest,Operation> deleteResourcePolicyCallable()

Deletes the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResourcePolicy = ProjectRegionResourcePolicyName.format("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   DeleteResourcePolicyHttpRequest request = DeleteResourcePolicyHttpRequest.newBuilder()
     .setResourcePolicy(formattedResourcePolicy)
     .build();
   ApiFuture<Operation> future = resourcePolicyClient.deleteResourcePolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getResourcePolicy

@BetaApi
public final ResourcePolicy getResourcePolicy(ProjectRegionResourcePolicyName resourcePolicy)

Retrieves all information of the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyName resourcePolicy = ProjectRegionResourcePolicyName.of("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   ResourcePolicy response = resourcePolicyClient.getResourcePolicy(resourcePolicy);
 }
 

Parameters:

resourcePolicy - Name of the resource policy to retrieve.

Throws:

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

getResourcePolicy

@BetaApi
public final ResourcePolicy getResourcePolicy(String resourcePolicy)

Retrieves all information of the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyName resourcePolicy = ProjectRegionResourcePolicyName.of("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   ResourcePolicy response = resourcePolicyClient.getResourcePolicy(resourcePolicy.toString());
 }
 

Parameters:

resourcePolicy - Name of the resource policy to retrieve.

Throws:

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

getResourcePolicy

@BetaApi
public final ResourcePolicy getResourcePolicy(GetResourcePolicyHttpRequest request)

Retrieves all information of the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResourcePolicy = ProjectRegionResourcePolicyName.format("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   GetResourcePolicyHttpRequest request = GetResourcePolicyHttpRequest.newBuilder()
     .setResourcePolicy(formattedResourcePolicy)
     .build();
   ResourcePolicy response = resourcePolicyClient.getResourcePolicy(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

getResourcePolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetResourcePolicyHttpRequest,ResourcePolicy> getResourcePolicyCallable()

Retrieves all information of the specified resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResourcePolicy = ProjectRegionResourcePolicyName.format("[PROJECT]", "[REGION]", "[RESOURCE_POLICY]");
   GetResourcePolicyHttpRequest request = GetResourcePolicyHttpRequest.newBuilder()
     .setResourcePolicy(formattedResourcePolicy)
     .build();
   ApiFuture<ResourcePolicy> future = resourcePolicyClient.getResourcePolicyCallable().futureCall(request);
   // Do something
   ResourcePolicy response = future.get();
 }
 

getIamPolicyResourcePolicy

@BetaApi
public final Policy getIamPolicyResourcePolicy(ProjectRegionResourcePolicyResourceName resource)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyResourceName resource = ProjectRegionResourcePolicyResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   Policy response = resourcePolicyClient.getIamPolicyResourcePolicy(resource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

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

getIamPolicyResourcePolicy

@BetaApi
public final Policy getIamPolicyResourcePolicy(String resource)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyResourceName resource = ProjectRegionResourcePolicyResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   Policy response = resourcePolicyClient.getIamPolicyResourcePolicy(resource.toString());
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

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

getIamPolicyResourcePolicy

@BetaApi
public final Policy getIamPolicyResourcePolicy(GetIamPolicyResourcePolicyHttpRequest request)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResource = ProjectRegionResourcePolicyResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   GetIamPolicyResourcePolicyHttpRequest request = GetIamPolicyResourcePolicyHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   Policy response = resourcePolicyClient.getIamPolicyResourcePolicy(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

getIamPolicyResourcePolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyResourcePolicyHttpRequest,Policy> getIamPolicyResourcePolicyCallable()

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResource = ProjectRegionResourcePolicyResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   GetIamPolicyResourcePolicyHttpRequest request = GetIamPolicyResourcePolicyHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   ApiFuture<Policy> future = resourcePolicyClient.getIamPolicyResourcePolicyCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

insertResourcePolicy

@BetaApi
public final Operation insertResourcePolicy(ProjectRegionName region,
                                                     ResourcePolicy resourcePolicyResource)

Creates a new resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   ResourcePolicy resourcePolicyResource = ResourcePolicy.newBuilder().build();
   Operation response = resourcePolicyClient.insertResourcePolicy(region, resourcePolicyResource);
 }
 

Parameters:

region - Name of the region for this request.

resourcePolicyResource -

Throws:

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

insertResourcePolicy

@BetaApi
public final Operation insertResourcePolicy(String region,
                                                     ResourcePolicy resourcePolicyResource)

Creates a new resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   ResourcePolicy resourcePolicyResource = ResourcePolicy.newBuilder().build();
   Operation response = resourcePolicyClient.insertResourcePolicy(region.toString(), resourcePolicyResource);
 }
 

Parameters:

region - Name of the region for this request.

resourcePolicyResource -

Throws:

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

insertResourcePolicy

@BetaApi
public final Operation insertResourcePolicy(InsertResourcePolicyHttpRequest request)

Creates a new resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ResourcePolicy resourcePolicyResource = ResourcePolicy.newBuilder().build();
   InsertResourcePolicyHttpRequest request = InsertResourcePolicyHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setResourcePolicyResource(resourcePolicyResource)
     .build();
   Operation response = resourcePolicyClient.insertResourcePolicy(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

insertResourcePolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertResourcePolicyHttpRequest,Operation> insertResourcePolicyCallable()

Creates a new resource policy.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ResourcePolicy resourcePolicyResource = ResourcePolicy.newBuilder().build();
   InsertResourcePolicyHttpRequest request = InsertResourcePolicyHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setResourcePolicyResource(resourcePolicyResource)
     .build();
   ApiFuture<Operation> future = resourcePolicyClient.insertResourcePolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listResourcePolicies

@BetaApi
public final ResourcePolicyClient.ListResourcePoliciesPagedResponse listResourcePolicies(ProjectRegionName region)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (ResourcePolicy element : resourcePolicyClient.listResourcePolicies(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region for this request.

Throws:

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

listResourcePolicies

@BetaApi
public final ResourcePolicyClient.ListResourcePoliciesPagedResponse listResourcePolicies(String region)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (ResourcePolicy element : resourcePolicyClient.listResourcePolicies(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region for this request.

Throws:

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

listResourcePolicies

@BetaApi
public final ResourcePolicyClient.ListResourcePoliciesPagedResponse listResourcePolicies(ListResourcePoliciesHttpRequest request)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListResourcePoliciesHttpRequest request = ListResourcePoliciesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (ResourcePolicy element : resourcePolicyClient.listResourcePolicies(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

listResourcePoliciesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesHttpRequest,ResourcePolicyClient.ListResourcePoliciesPagedResponse> listResourcePoliciesPagedCallable()

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListResourcePoliciesHttpRequest request = ListResourcePoliciesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListResourcePoliciesPagedResponse> future = resourcePolicyClient.listResourcePoliciesPagedCallable().futureCall(request);
   // Do something
   for (ResourcePolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listResourcePoliciesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesHttpRequest,ResourcePolicyList> listResourcePoliciesCallable()

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListResourcePoliciesHttpRequest request = ListResourcePoliciesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     ResourcePolicyList response = resourcePolicyClient.listResourcePoliciesCallable().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;
     }
   }
 }
 

setIamPolicyResourcePolicy

@BetaApi
public final Policy setIamPolicyResourcePolicy(ProjectRegionResourcePolicyResourceName resource,
                                                        RegionSetPolicyRequest regionSetPolicyRequestResource)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyResourceName resource = ProjectRegionResourcePolicyResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   Policy response = resourcePolicyClient.setIamPolicyResourcePolicy(resource, regionSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

regionSetPolicyRequestResource -

Throws:

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

setIamPolicyResourcePolicy

@BetaApi
public final Policy setIamPolicyResourcePolicy(String resource,
                                                        RegionSetPolicyRequest regionSetPolicyRequestResource)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyResourceName resource = ProjectRegionResourcePolicyResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   Policy response = resourcePolicyClient.setIamPolicyResourcePolicy(resource.toString(), regionSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

regionSetPolicyRequestResource -

Throws:

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

setIamPolicyResourcePolicy

@BetaApi
public final Policy setIamPolicyResourcePolicy(SetIamPolicyResourcePolicyHttpRequest request)

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResource = ProjectRegionResourcePolicyResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   SetIamPolicyResourcePolicyHttpRequest request = SetIamPolicyResourcePolicyHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setRegionSetPolicyRequestResource(regionSetPolicyRequestResource)
     .build();
   Policy response = resourcePolicyClient.setIamPolicyResourcePolicy(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

setIamPolicyResourcePolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyResourcePolicyHttpRequest,Policy> setIamPolicyResourcePolicyCallable()

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

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResource = ProjectRegionResourcePolicyResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   SetIamPolicyResourcePolicyHttpRequest request = SetIamPolicyResourcePolicyHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setRegionSetPolicyRequestResource(regionSetPolicyRequestResource)
     .build();
   ApiFuture<Policy> future = resourcePolicyClient.setIamPolicyResourcePolicyCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

testIamPermissionsResourcePolicy

@BetaApi
public final TestPermissionsResponse testIamPermissionsResourcePolicy(ProjectRegionResourcePolicyResourceName resource,
                                                                               TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyResourceName resource = ProjectRegionResourcePolicyResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = resourcePolicyClient.testIamPermissionsResourcePolicy(resource, testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

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

testIamPermissionsResourcePolicy

@BetaApi
public final TestPermissionsResponse testIamPermissionsResourcePolicy(String resource,
                                                                               TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   ProjectRegionResourcePolicyResourceName resource = ProjectRegionResourcePolicyResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = resourcePolicyClient.testIamPermissionsResourcePolicy(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

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

testIamPermissionsResourcePolicy

@BetaApi
public final TestPermissionsResponse testIamPermissionsResourcePolicy(TestIamPermissionsResourcePolicyHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResource = ProjectRegionResourcePolicyResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsResourcePolicyHttpRequest request = TestIamPermissionsResourcePolicyHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = resourcePolicyClient.testIamPermissionsResourcePolicy(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

testIamPermissionsResourcePolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsResourcePolicyHttpRequest,TestPermissionsResponse> testIamPermissionsResourcePolicyCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ResourcePolicyClient resourcePolicyClient = ResourcePolicyClient.create()) {
   String formattedResource = ProjectRegionResourcePolicyResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsResourcePolicyHttpRequest request = TestIamPermissionsResourcePolicyHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = resourcePolicyClient.testIamPermissionsResourcePolicyCallable().futureCall(request);
   // Do something
   TestPermissionsResponse response = future.get();
 }
 

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