| GitHub Repository | Product Reference |
Service Description: The Protection Summary service.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = backupDrProtectionSummaryClient.getLocation(request);
}
Note: close() needs to be called on the BackupDrProtectionSummaryClient 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 |
|---|---|---|
ListResourceBackupConfigs |
Lists ResourceBackupConfigs. |
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.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
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. Replacesany existing policy. Can return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
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. Returns an empty policyif the resource exists and does not have a policy set. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
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. If theresource does not exist, this will return an empty set ofpermissions, not a Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
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 BackupDrProtectionSummarySettings 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
BackupDrProtectionSummarySettings backupDrProtectionSummarySettings =
BackupDrProtectionSummarySettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create(backupDrProtectionSummarySettings);
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
BackupDrProtectionSummarySettings backupDrProtectionSummarySettings =
BackupDrProtectionSummarySettings.newBuilder().setEndpoint(myEndpoint).build();
BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create(backupDrProtectionSummarySettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BackupDrProtectionSummarySettings backupDrProtectionSummarySettings =
BackupDrProtectionSummarySettings.newHttpJsonBuilder().build();
BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create(backupDrProtectionSummarySettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final BackupDrProtectionSummaryClient create()Constructs an instance of BackupDrProtectionSummaryClient with default settings.
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(BackupDrProtectionSummarySettings settings)
public static final BackupDrProtectionSummaryClient create(BackupDrProtectionSummarySettings settings)Constructs an instance of BackupDrProtectionSummaryClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
BackupDrProtectionSummarySettings |
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(BackupDrProtectionSummaryStub stub)
public static final BackupDrProtectionSummaryClient create(BackupDrProtectionSummaryStub stub)Constructs an instance of BackupDrProtectionSummaryClient, using the given stub for making calls. This is for advanced usage - prefer using create(BackupDrProtectionSummarySettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
BackupDrProtectionSummaryStub |
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient |
|
Constructors
BackupDrProtectionSummaryClient(BackupDrProtectionSummarySettings settings)
protected BackupDrProtectionSummaryClient(BackupDrProtectionSummarySettings settings)Constructs an instance of BackupDrProtectionSummaryClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
BackupDrProtectionSummarySettings |
BackupDrProtectionSummaryClient(BackupDrProtectionSummaryStub stub)
protected BackupDrProtectionSummaryClient(BackupDrProtectionSummaryStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
BackupDrProtectionSummaryStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
public final void close()getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
ManagementServerName.of("[PROJECT]", "[LOCATION]", "[MANAGEMENTSERVER]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = backupDrProtectionSummaryClient.getIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
ManagementServerName.of("[PROJECT]", "[LOCATION]", "[MANAGEMENTSERVER]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
backupDrProtectionSummaryClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)Gets information about a location.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = backupDrProtectionSummaryClient.getLocation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.GetLocationRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.location.Location |
|
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()Gets information about a location.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
backupDrProtectionSummaryClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getSettings()
public final BackupDrProtectionSummarySettings getSettings()| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummarySettings |
|
getStub()
public BackupDrProtectionSummaryStub getStub()| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listLocations(ListLocationsRequest request)
public final BackupDrProtectionSummaryClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)Lists information about the supported locations for this service.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : backupDrProtectionSummaryClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient.ListLocationsPagedResponse |
|
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()Lists information about the supported locations for this service.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
backupDrProtectionSummaryClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
|
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,BackupDrProtectionSummaryClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
backupDrProtectionSummaryClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
listResourceBackupConfigs(ListResourceBackupConfigsRequest request)
public final BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse listResourceBackupConfigs(ListResourceBackupConfigsRequest request)Lists ResourceBackupConfigs.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
ListResourceBackupConfigsRequest request =
ListResourceBackupConfigsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (ResourceBackupConfig element :
backupDrProtectionSummaryClient.listResourceBackupConfigs(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListResourceBackupConfigsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse |
|
listResourceBackupConfigs(LocationName parent)
public final BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse listResourceBackupConfigs(LocationName parent)Lists ResourceBackupConfigs.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (ResourceBackupConfig element :
backupDrProtectionSummaryClient.listResourceBackupConfigs(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
LocationNameRequired. The project and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example
|
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse |
|
listResourceBackupConfigs(String parent)
public final BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse listResourceBackupConfigs(String parent)Lists ResourceBackupConfigs.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (ResourceBackupConfig element :
backupDrProtectionSummaryClient.listResourceBackupConfigs(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The project and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example
|
| Returns | |
|---|---|
| Type | Description |
BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse |
|
listResourceBackupConfigsCallable()
public final UnaryCallable<ListResourceBackupConfigsRequest,ListResourceBackupConfigsResponse> listResourceBackupConfigsCallable()Lists ResourceBackupConfigs.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
ListResourceBackupConfigsRequest request =
ListResourceBackupConfigsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListResourceBackupConfigsResponse response =
backupDrProtectionSummaryClient.listResourceBackupConfigsCallable().call(request);
for (ResourceBackupConfig element : response.getResourceBackupConfigsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListResourceBackupConfigsRequest,ListResourceBackupConfigsResponse> |
|
listResourceBackupConfigsPagedCallable()
public final UnaryCallable<ListResourceBackupConfigsRequest,BackupDrProtectionSummaryClient.ListResourceBackupConfigsPagedResponse> listResourceBackupConfigsPagedCallable()Lists ResourceBackupConfigs.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
ListResourceBackupConfigsRequest request =
ListResourceBackupConfigsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<ResourceBackupConfig> future =
backupDrProtectionSummaryClient
.listResourceBackupConfigsPagedCallable()
.futureCall(request);
// Do something.
for (ResourceBackupConfig element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListResourceBackupConfigsRequest,ListResourceBackupConfigsPagedResponse> |
|
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
ManagementServerName.of("[PROJECT]", "[LOCATION]", "[MANAGEMENTSERVER]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = backupDrProtectionSummaryClient.setIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
ManagementServerName.of("[PROJECT]", "[LOCATION]", "[MANAGEMENTSERVER]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
backupDrProtectionSummaryClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
ManagementServerName.of("[PROJECT]", "[LOCATION]", "[MANAGEMENTSERVER]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
backupDrProtectionSummaryClient.testIamPermissions(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
|
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
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 (BackupDrProtectionSummaryClient backupDrProtectionSummaryClient =
BackupDrProtectionSummaryClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
ManagementServerName.of("[PROJECT]", "[LOCATION]", "[MANAGEMENTSERVER]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
backupDrProtectionSummaryClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|