@Generated(value="by gapic-generator-java") public class ResourcePoliciesClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Delete |
Deletes the specified resource policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Insert |
Creates a new resource policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Patch |
Modify the specified resource policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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:
// 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.
| Modifier and Type | Class and Description |
|---|---|
static class |
ResourcePoliciesClient.AggregatedListFixedSizeCollection |
static class |
ResourcePoliciesClient.AggregatedListPage |
static class |
ResourcePoliciesClient.AggregatedListPagedResponse |
static class |
ResourcePoliciesClient.ListFixedSizeCollection |
static class |
ResourcePoliciesClient.ListPage |
static class |
ResourcePoliciesClient.ListPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
ResourcePoliciesClient(ResourcePoliciesSettings settings)
Constructs an instance of ResourcePoliciesClient, using the given settings.
|
protected |
ResourcePoliciesClient(ResourcePoliciesStub stub) |
| Modifier and Type | Method and Description |
|---|---|
ResourcePoliciesClient.AggregatedListPagedResponse |
aggregatedList(AggregatedListResourcePoliciesRequest request)
Retrieves an aggregated list of resource policies.
|
ResourcePoliciesClient.AggregatedListPagedResponse |
aggregatedList(String project)
Retrieves an aggregated list of resource policies.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePolicyAggregatedList> |
aggregatedListCallable()
Retrieves an aggregated list of resource policies.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePoliciesClient.AggregatedListPagedResponse> |
aggregatedListPagedCallable()
Retrieves an aggregated list of resource policies.
|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static ResourcePoliciesClient |
create()
Constructs an instance of ResourcePoliciesClient with default settings.
|
static ResourcePoliciesClient |
create(ResourcePoliciesSettings settings)
Constructs an instance of ResourcePoliciesClient, using the given settings.
|
static ResourcePoliciesClient |
create(ResourcePoliciesStub stub)
Constructs an instance of ResourcePoliciesClient, using the given stub for making calls.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(DeleteResourcePolicyRequest request)
Deletes the specified resource policy.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(String project,
String region,
String resourcePolicy)
Deletes the specified resource policy.
|
com.google.api.gax.rpc.UnaryCallable<DeleteResourcePolicyRequest,Operation> |
deleteCallable()
Deletes the specified resource policy.
|
com.google.api.gax.rpc.OperationCallable<DeleteResourcePolicyRequest,Operation,Operation> |
deleteOperationCallable()
Deletes the specified resource policy.
|
ResourcePolicy |
get(GetResourcePolicyRequest request)
Retrieves all information of the specified resource policy.
|
ResourcePolicy |
get(String project,
String region,
String resourcePolicy)
Retrieves all information of the specified resource policy.
|
com.google.api.gax.rpc.UnaryCallable<GetResourcePolicyRequest,ResourcePolicy> |
getCallable()
Retrieves all information of the specified resource policy.
|
Policy |
getIamPolicy(GetIamPolicyResourcePolicyRequest request)
Gets the access control policy for a resource.
|
Policy |
getIamPolicy(String project,
String region,
String resource)
Gets the access control policy for a resource.
|
com.google.api.gax.rpc.UnaryCallable<GetIamPolicyResourcePolicyRequest,Policy> |
getIamPolicyCallable()
Gets the access control policy for a resource.
|
ResourcePoliciesSettings |
getSettings() |
ResourcePoliciesStub |
getStub() |
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(InsertResourcePolicyRequest request)
Creates a new resource policy.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(String project,
String region,
ResourcePolicy resourcePolicyResource)
Creates a new resource policy.
|
com.google.api.gax.rpc.UnaryCallable<InsertResourcePolicyRequest,Operation> |
insertCallable()
Creates a new resource policy.
|
com.google.api.gax.rpc.OperationCallable<InsertResourcePolicyRequest,Operation,Operation> |
insertOperationCallable()
Creates a new resource policy.
|
boolean |
isShutdown() |
boolean |
isTerminated() |
ResourcePoliciesClient.ListPagedResponse |
list(ListResourcePoliciesRequest request)
A list all the resource policies that have been configured for the specified project in
specified region.
|
ResourcePoliciesClient.ListPagedResponse |
list(String project,
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<ListResourcePoliciesRequest,ResourcePolicyList> |
listCallable()
A list all the resource policies that have been configured for the specified project in
specified region.
|
com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesRequest,ResourcePoliciesClient.ListPagedResponse> |
listPagedCallable()
A list all the resource policies that have been configured for the specified project in
specified region.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
patchAsync(PatchResourcePolicyRequest request)
Modify the specified resource policy.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
patchAsync(String project,
String region,
String resourcePolicy,
ResourcePolicy resourcePolicyResource)
Modify the specified resource policy.
|
com.google.api.gax.rpc.UnaryCallable<PatchResourcePolicyRequest,Operation> |
patchCallable()
Modify the specified resource policy.
|
com.google.api.gax.rpc.OperationCallable<PatchResourcePolicyRequest,Operation,Operation> |
patchOperationCallable()
Modify the specified resource policy.
|
Policy |
setIamPolicy(SetIamPolicyResourcePolicyRequest request)
Sets the access control policy on the specified resource.
|
Policy |
setIamPolicy(String project,
String region,
String resource,
RegionSetPolicyRequest regionSetPolicyRequestResource)
Sets the access control policy on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<SetIamPolicyResourcePolicyRequest,Policy> |
setIamPolicyCallable()
Sets the access control policy on the specified resource.
|
void |
shutdown() |
void |
shutdownNow() |
TestPermissionsResponse |
testIamPermissions(String project,
String region,
String resource,
TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.
|
TestPermissionsResponse |
testIamPermissions(TestIamPermissionsResourcePolicyRequest request)
Returns permissions that a caller has on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsResourcePolicyRequest,TestPermissionsResponse> |
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
|
protected ResourcePoliciesClient(ResourcePoliciesSettings settings) throws IOException
IOExceptionprotected ResourcePoliciesClient(ResourcePoliciesStub stub)
public static final ResourcePoliciesClient create() throws IOException
IOExceptionpublic static final ResourcePoliciesClient create(ResourcePoliciesSettings settings) throws IOException
IOExceptionpublic static final ResourcePoliciesClient create(ResourcePoliciesStub stub)
public final ResourcePoliciesSettings getSettings()
public ResourcePoliciesStub getStub()
public final ResourcePoliciesClient.AggregatedListPagedResponse aggregatedList(String project)
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);
}
}
project - Project ID for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ResourcePoliciesClient.AggregatedListPagedResponse aggregatedList(AggregatedListResourcePoliciesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePoliciesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListResourcePoliciesRequest,ResourcePolicyAggregatedList> aggregatedListCallable()
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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String region, String resourcePolicy)
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();
}
project - Project ID for this request.region - Name of the region for this request.resourcePolicy - Name of the resource policy to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<DeleteResourcePolicyRequest,Operation,Operation> deleteOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<DeleteResourcePolicyRequest,Operation> deleteCallable()
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();
}
public final ResourcePolicy get(String project, String region, String resourcePolicy)
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);
}
project - Project ID for this request.region - Name of the region for this request.resourcePolicy - Name of the resource policy to retrieve.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ResourcePolicy get(GetResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.create()) {
GetResourcePolicyRequest request =
GetResourcePolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setResourcePolicy("resourcePolicy-130903328")
.build();
ResourcePolicy response = resourcePoliciesClient.get(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetResourcePolicyRequest,ResourcePolicy> getCallable()
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();
}
public final Policy getIamPolicy(String project, String region, String 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";
Policy response = resourcePoliciesClient.getIamPolicy(project, region, resource);
}
project - Project ID for this request.region - The name of the region for this request.resource - Name or id of the resource for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Policy getIamPolicy(GetIamPolicyResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyResourcePolicyRequest,Policy> getIamPolicyCallable()
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();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String region, ResourcePolicy resourcePolicyResource)
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();
}
project - Project ID for this request.region - Name of the region for this request.resourcePolicyResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<InsertResourcePolicyRequest,Operation,Operation> insertOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<InsertResourcePolicyRequest,Operation> insertCallable()
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();
}
public final ResourcePoliciesClient.ListPagedResponse list(String project, String 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);
}
}
project - Project ID for this request.region - Name of the region for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ResourcePoliciesClient.ListPagedResponse list(ListResourcePoliciesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesRequest,ResourcePoliciesClient.ListPagedResponse> listPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListResourcePoliciesRequest,ResourcePolicyList> listCallable()
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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project, String region, String resourcePolicy, ResourcePolicy resourcePolicyResource)
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();
}
project - Project ID for this request.region - Name of the region for this request.resourcePolicy - Id of the resource policy to patch.resourcePolicyResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<PatchResourcePolicyRequest,Operation,Operation> patchOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<PatchResourcePolicyRequest,Operation> patchCallable()
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();
}
public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
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);
}
project - Project ID for this request.region - The name of the region for this request.resource - Name or id of the resource for this request.regionSetPolicyRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final Policy setIamPolicy(SetIamPolicyResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyResourcePolicyRequest,Policy> setIamPolicyCallable()
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();
}
public final TestPermissionsResponse testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)
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);
}
project - Project ID for this request.region - The name of the region for this request.resource - Name or id of the resource for this request.testPermissionsRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final TestPermissionsResponse testIamPermissions(TestIamPermissionsResourcePolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsResourcePolicyRequest,TestPermissionsResponse> testIamPermissionsCallable()
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();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.