Class RegionDisksClient (1.88.0)

GitHub RepositoryProduct Reference

Service Description: The RegionDisks API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


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

Note: close() needs to be called on the RegionDisksClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

AddResourcePolicies

Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

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

  • addResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest request)

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

  • addResourcePoliciesAsync(String project, String region, String disk, RegionDisksAddResourcePoliciesRequest regionDisksAddResourcePoliciesRequestResource)

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

  • addResourcePoliciesOperationCallable()

  • addResourcePoliciesCallable()

BulkInsert

Bulk create a set of disks.

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

  • bulkInsertAsync(BulkInsertRegionDiskRequest request)

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

  • bulkInsertAsync(String project, String region, BulkInsertDiskResource bulkInsertDiskResourceResource)

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

  • bulkInsertOperationCallable()

  • bulkInsertCallable()

CreateSnapshot

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

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

  • createSnapshotAsync(CreateSnapshotRegionDiskRequest request)

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

  • createSnapshotAsync(String project, String region, String disk, Snapshot snapshotResource)

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

  • createSnapshotOperationCallable()

  • createSnapshotCallable()

Delete

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

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

  • deleteAsync(DeleteRegionDiskRequest request)

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

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

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

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns a specified regional persistent disk.

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

  • get(GetRegionDiskRequest request)

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

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

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

  • getCallable()

GetIamPolicy

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

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

  • getIamPolicy(GetIamPolicyRegionDiskRequest request)

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

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

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

  • getIamPolicyCallable()

Insert

Creates a persistent regional disk in the specified project using the data included in the request.

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

  • insertAsync(InsertRegionDiskRequest request)

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

  • insertAsync(String project, String region, Disk diskResource)

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

  • insertOperationCallable()

  • insertCallable()

List

Retrieves the list of persistent disks contained within the specified region.

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

  • list(ListRegionDisksRequest request)

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

  • list(String project, String region)

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

  • listPagedCallable()

  • listCallable()

RemoveResourcePolicies

Removes resource policies from a regional disk.

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

  • removeResourcePoliciesAsync(RemoveResourcePoliciesRegionDiskRequest request)

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

  • removeResourcePoliciesAsync(String project, String region, String disk, RegionDisksRemoveResourcePoliciesRequest regionDisksRemoveResourcePoliciesRequestResource)

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

  • removeResourcePoliciesOperationCallable()

  • removeResourcePoliciesCallable()

Resize

Resizes the specified regional persistent disk.

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

  • resizeAsync(ResizeRegionDiskRequest request)

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

  • resizeAsync(String project, String region, String disk, RegionDisksResizeRequest regionDisksResizeRequestResource)

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

  • resizeOperationCallable()

  • resizeCallable()

SetIamPolicy

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

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

  • setIamPolicy(SetIamPolicyRegionDiskRequest request)

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

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

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

  • setIamPolicyCallable()

SetLabels

Sets the labels on the target regional disk.

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

  • setLabelsAsync(SetLabelsRegionDiskRequest request)

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

  • setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)

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

  • setLabelsOperationCallable()

  • setLabelsCallable()

StartAsyncReplication

Starts asynchronous replication. Must be invoked on the primary disk.

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

  • startAsyncReplicationAsync(StartAsyncReplicationRegionDiskRequest request)

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

  • startAsyncReplicationAsync(String project, String region, String disk, RegionDisksStartAsyncReplicationRequest regionDisksStartAsyncReplicationRequestResource)

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

  • startAsyncReplicationOperationCallable()

  • startAsyncReplicationCallable()

StopAsyncReplication

Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

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

  • stopAsyncReplicationAsync(StopAsyncReplicationRegionDiskRequest request)

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

  • stopAsyncReplicationAsync(String project, String region, String disk)

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

  • stopAsyncReplicationOperationCallable()

  • stopAsyncReplicationCallable()

StopGroupAsyncReplication

Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

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

  • stopGroupAsyncReplicationAsync(StopGroupAsyncReplicationRegionDiskRequest request)

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

  • stopGroupAsyncReplicationAsync(String project, String region, DisksStopGroupAsyncReplicationResource disksStopGroupAsyncReplicationResourceResource)

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

  • stopGroupAsyncReplicationOperationCallable()

  • stopGroupAsyncReplicationCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource.

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

  • testIamPermissions(TestIamPermissionsRegionDiskRequest request)

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

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

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

  • testIamPermissionsCallable()

Update

Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

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

  • updateAsync(UpdateRegionDiskRequest request)

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

  • updateAsync(String project, String region, String disk, Disk diskResource)

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

  • updateOperationCallable()

  • updateCallable()

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 RegionDisksSettings 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
 RegionDisksSettings regionDisksSettings =
     RegionDisksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionDisksClient regionDisksClient = RegionDisksClient.create(regionDisksSettings);

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
 RegionDisksSettings regionDisksSettings =
     RegionDisksSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionDisksClient regionDisksClient = RegionDisksClient.create(regionDisksSettings);

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

Inheritance

java.lang.Object > RegionDisksClient

Static Methods

create()

public static final RegionDisksClient create()

Constructs an instance of RegionDisksClient with default settings.

Returns
Type Description
RegionDisksClient
Exceptions
Type Description
IOException

create(RegionDisksSettings settings)

public static final RegionDisksClient create(RegionDisksSettings settings)

Constructs an instance of RegionDisksClient, 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 RegionDisksSettings
Returns
Type Description
RegionDisksClient
Exceptions
Type Description
IOException

create(RegionDisksStub stub)

public static final RegionDisksClient create(RegionDisksStub stub)

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

Parameter
Name Description
stub RegionDisksStub
Returns
Type Description
RegionDisksClient

Constructors

RegionDisksClient(RegionDisksSettings settings)

protected RegionDisksClient(RegionDisksSettings settings)

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

RegionDisksClient(RegionDisksStub stub)

protected RegionDisksClient(RegionDisksStub stub)
Parameter
Name Description
stub RegionDisksStub

Methods

addResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest request)

public final OperationFuture<Operation,Operation> addResourcePoliciesAsync(AddResourcePoliciesRegionDiskRequest request)

Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

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 (RegionDisksClient regionDisksClient = RegionDisksClient.create()) {
   AddResourcePoliciesRegionDiskRequest request =
       AddResourcePoliciesRegionDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionDisksAddResourcePoliciesRequestResource(
               RegionDisksAddResourcePoliciesRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionDisksClient.addResourcePoliciesAsync(request).get();
 }
Parameter
Name Description
request AddResourcePoliciesRegionDiskRequest

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

addResourcePoliciesAsync(String project, String region, String disk, RegionDisksAddResourcePoliciesRequest regionDisksAddResourcePoliciesRequestResource)

public final OperationFuture<Operation,Operation> addResourcePoliciesAsync(String project, String region, String disk, RegionDisksAddResourcePoliciesRequest regionDisksAddResourcePoliciesRequestResource)

Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

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 (RegionDisksClient regionDisksClient = RegionDisksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String disk = "disk3083677";
   RegionDisksAddResourcePoliciesRequest regionDisksAddResourcePoliciesRequestResource =
       RegionDisksAddResourcePoliciesRequest.newBuilder().build();
   Operation response =
       regionDisksClient
           .addResourcePoliciesAsync(
               project, region, disk, regionDisksAddResourcePoliciesRequestResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

The name of the region for this request.
disk String

The disk name for this request.
regionDisksAddResourcePoliciesRequestResource RegionDisksAddResourcePoliciesRequest

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

addResourcePoliciesCallable()

public final UnaryCallable<AddResourcePoliciesRegionDiskRequest,Operation> addResourcePoliciesCallable()

Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

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 (RegionDisksClient regionDisksClient = RegionDisksClient.create()) {
   AddResourcePoliciesRegionDiskRequest request =
       AddResourcePoliciesRegionDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionDisksAddResourcePoliciesRequestResource(
               RegionDisksAddResourcePoliciesRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionDisksClient.addResourcePoliciesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<AddResourcePoliciesRegionDiskRequest,Operation>

addResourcePoliciesOperationCallable()

public final OperationCallable<AddResourcePoliciesRegionDiskRequest,Operation,Operation> addResourcePoliciesOperationCallable()

Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

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 (RegionDisksClient regionDisksClient = RegionDisksClient.create()) {
   AddResourcePoliciesRegionDiskRequest request =
       AddResourcePoliciesRegionDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionDisksAddResourcePoliciesRequestResource(
               RegionDisksAddResourcePoliciesRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionDisksClient.addResourcePoliciesOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<AddResourcePoliciesRegionDiskRequest,Operation,Operation>

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

bulkInsertAsync(BulkInsertRegionDiskRequest request)

public final OperationFuture<Operation,Operation> bulkInsertAsync(BulkInsertRegionDiskRequest request)

Bulk create a set of disks.

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 (RegionDisksClient regionDisksClient = RegionDisksClient.create()) {
   BulkInsertRegionDiskRequest request =
       BulkInsertRegionDiskRequest.newBuilder()
           .setBulkInsertDiskResourceResource(BulkInsertDiskResource.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionDisksClient.bulkInsertAsync(request).get();
 }
Parameter
Name Description
request BulkInsertRegionDiskRequest

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