Class DisksClient (1.21.0)

public class DisksClient implements BackgroundResource

Service Description: The Disks 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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   Disk response = disksClient.get(project, zone, disk);
 }
 

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

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

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of DisksSettings 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
 DisksSettings disksSettings =
     DisksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DisksClient disksClient = DisksClient.create(disksSettings);
 

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
 DisksSettings disksSettings = DisksSettings.newBuilder().setEndpoint(myEndpoint).build();
 DisksClient disksClient = DisksClient.create(disksSettings);
 

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

Inheritance

java.lang.Object > DisksClient

Implements

BackgroundResource

Static Methods

create()

public static final DisksClient create()

Constructs an instance of DisksClient with default settings.

Returns
TypeDescription
DisksClient
Exceptions
TypeDescription
IOException

create(DisksSettings settings)

public static final DisksClient create(DisksSettings settings)

Constructs an instance of DisksClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsDisksSettings
Returns
TypeDescription
DisksClient
Exceptions
TypeDescription
IOException

create(DisksStub stub)

public static final DisksClient create(DisksStub stub)

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

Parameter
NameDescription
stubDisksStub
Returns
TypeDescription
DisksClient

Constructors

DisksClient(DisksSettings settings)

protected DisksClient(DisksSettings settings)

Constructs an instance of DisksClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsDisksSettings

DisksClient(DisksStub stub)

protected DisksClient(DisksStub stub)
Parameter
NameDescription
stubDisksStub

Methods

addResourcePoliciesAsync(AddResourcePoliciesDiskRequest request)

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

Adds existing resource policies to a 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 (DisksClient disksClient = DisksClient.create()) {
   AddResourcePoliciesDiskRequest request =
       AddResourcePoliciesDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksAddResourcePoliciesRequestResource(
               DisksAddResourcePoliciesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = disksClient.addResourcePoliciesAsync(request).get();
 }
 
Parameter
NameDescription
requestAddResourcePoliciesDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

addResourcePoliciesAsync(String project, String zone, String disk, DisksAddResourcePoliciesRequest disksAddResourcePoliciesRequestResource)

public final OperationFuture<Operation,Operation> addResourcePoliciesAsync(String project, String zone, String disk, DisksAddResourcePoliciesRequest disksAddResourcePoliciesRequestResource)

Adds existing resource policies to a 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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   DisksAddResourcePoliciesRequest disksAddResourcePoliciesRequestResource =
       DisksAddResourcePoliciesRequest.newBuilder().build();
   Operation response =
       disksClient
           .addResourcePoliciesAsync(
               project, zone, disk, disksAddResourcePoliciesRequestResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskString

The disk name for this request.

disksAddResourcePoliciesRequestResourceDisksAddResourcePoliciesRequest

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

addResourcePoliciesCallable()

public final UnaryCallable<AddResourcePoliciesDiskRequest,Operation> addResourcePoliciesCallable()

Adds existing resource policies to a 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 (DisksClient disksClient = DisksClient.create()) {
   AddResourcePoliciesDiskRequest request =
       AddResourcePoliciesDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksAddResourcePoliciesRequestResource(
               DisksAddResourcePoliciesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = disksClient.addResourcePoliciesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<AddResourcePoliciesDiskRequest,Operation>

addResourcePoliciesOperationCallable()

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

Adds existing resource policies to a 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 (DisksClient disksClient = DisksClient.create()) {
   AddResourcePoliciesDiskRequest request =
       AddResourcePoliciesDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksAddResourcePoliciesRequestResource(
               DisksAddResourcePoliciesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.addResourcePoliciesOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<AddResourcePoliciesDiskRequest,Operation,Operation>

aggregatedList(AggregatedListDisksRequest request)

public final DisksClient.AggregatedListPagedResponse aggregatedList(AggregatedListDisksRequest request)

Retrieves an aggregated list of persistent 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 (DisksClient disksClient = DisksClient.create()) {
   AggregatedListDisksRequest request =
       AggregatedListDisksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, DisksScopedList> element :
       disksClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestAggregatedListDisksRequest

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

Returns
TypeDescription
DisksClient.AggregatedListPagedResponse

aggregatedList(String project)

public final DisksClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of persistent 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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, DisksScopedList> element :
       disksClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
DisksClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListDisksRequest,DiskAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of persistent 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 (DisksClient disksClient = DisksClient.create()) {
   AggregatedListDisksRequest request =
       AggregatedListDisksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     DiskAggregatedList response = disksClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, DisksScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<AggregatedListDisksRequest,DiskAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListDisksRequest,DisksClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of persistent 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 (DisksClient disksClient = DisksClient.create()) {
   AggregatedListDisksRequest request =
       AggregatedListDisksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, DisksScopedList>> future =
       disksClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, DisksScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<AggregatedListDisksRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

createSnapshotAsync(CreateSnapshotDiskRequest request)

public final OperationFuture<Operation,Operation> createSnapshotAsync(CreateSnapshotDiskRequest request)

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.

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 (DisksClient disksClient = DisksClient.create()) {
   CreateSnapshotDiskRequest request =
       CreateSnapshotDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setGuestFlush(true)
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSnapshotResource(Snapshot.newBuilder().build())
           .setZone("zone3744684")
           .build();
   Operation response = disksClient.createSnapshotAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateSnapshotDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

createSnapshotAsync(String project, String zone, String disk, Snapshot snapshotResource)

public final OperationFuture<Operation,Operation> createSnapshotAsync(String project, String zone, String disk, Snapshot snapshotResource)

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.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   Snapshot snapshotResource = Snapshot.newBuilder().build();
   Operation response =
       disksClient.createSnapshotAsync(project, zone, disk, snapshotResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskString

Name of the persistent disk to snapshot.

snapshotResourceSnapshot

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

createSnapshotCallable()

public final UnaryCallable<CreateSnapshotDiskRequest,Operation> createSnapshotCallable()

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.

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 (DisksClient disksClient = DisksClient.create()) {
   CreateSnapshotDiskRequest request =
       CreateSnapshotDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setGuestFlush(true)
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSnapshotResource(Snapshot.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = disksClient.createSnapshotCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateSnapshotDiskRequest,Operation>

createSnapshotOperationCallable()

public final OperationCallable<CreateSnapshotDiskRequest,Operation,Operation> createSnapshotOperationCallable()

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.

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 (DisksClient disksClient = DisksClient.create()) {
   CreateSnapshotDiskRequest request =
       CreateSnapshotDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setGuestFlush(true)
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSnapshotResource(Snapshot.newBuilder().build())
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.createSnapshotOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateSnapshotDiskRequest,Operation,Operation>

deleteAsync(DeleteDiskRequest request)

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

Deletes the specified persistent disk. Deleting a disk removes 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.

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 (DisksClient disksClient = DisksClient.create()) {
   DeleteDiskRequest request =
       DeleteDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = disksClient.deleteAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteAsync(String project, String zone, String disk)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String disk)

Deletes the specified persistent disk. Deleting a disk removes 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.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   Operation response = disksClient.deleteAsync(project, zone, disk).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskString

Name of the persistent disk to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteDiskRequest,Operation> deleteCallable()

Deletes the specified persistent disk. Deleting a disk removes 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.

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 (DisksClient disksClient = DisksClient.create()) {
   DeleteDiskRequest request =
       DeleteDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = disksClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteDiskRequest,Operation>

deleteOperationCallable()

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

Deletes the specified persistent disk. Deleting a disk removes 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.

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 (DisksClient disksClient = DisksClient.create()) {
   DeleteDiskRequest request =
       DeleteDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteDiskRequest,Operation,Operation>

get(GetDiskRequest request)

public final Disk get(GetDiskRequest request)

Returns a specified persistent disk. Gets a list of available persistent disks by making a list() 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 (DisksClient disksClient = DisksClient.create()) {
   GetDiskRequest request =
       GetDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Disk response = disksClient.get(request);
 }
 
Parameter
NameDescription
requestGetDiskRequest

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

Returns
TypeDescription
Disk

get(String project, String zone, String disk)

public final Disk get(String project, String zone, String disk)

Returns a specified persistent disk. Gets a list of available persistent disks by making a list() 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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   Disk response = disksClient.get(project, zone, disk);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskString

Name of the persistent disk to return.

Returns
TypeDescription
Disk

getCallable()

public final UnaryCallable<GetDiskRequest,Disk> getCallable()

Returns a specified persistent disk. Gets a list of available persistent disks by making a list() 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 (DisksClient disksClient = DisksClient.create()) {
   GetDiskRequest request =
       GetDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<Disk> future = disksClient.getCallable().futureCall(request);
   // Do something.
   Disk response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetDiskRequest,Disk>

getIamPolicy(GetIamPolicyDiskRequest request)

public final Policy getIamPolicy(GetIamPolicyDiskRequest request)

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

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 (DisksClient disksClient = DisksClient.create()) {
   GetIamPolicyDiskRequest request =
       GetIamPolicyDiskRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .build();
   Policy response = disksClient.getIamPolicy(request);
 }
 
Parameter
NameDescription
requestGetIamPolicyDiskRequest

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

Returns
TypeDescription
Policy

getIamPolicy(String project, String zone, String resource)

public final Policy getIamPolicy(String project, String zone, String resource)

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

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   Policy response = disksClient.getIamPolicy(project, zone, resource);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

Returns
TypeDescription
Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyDiskRequest,Policy> getIamPolicyCallable()

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

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 (DisksClient disksClient = DisksClient.create()) {
   GetIamPolicyDiskRequest request =
       GetIamPolicyDiskRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .build();
   ApiFuture<Policy> future = disksClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetIamPolicyDiskRequest,Policy>

getSettings()

public final DisksSettings getSettings()
Returns
TypeDescription
DisksSettings

getStub()

public DisksStub getStub()
Returns
TypeDescription
DisksStub

insertAsync(InsertDiskRequest request)

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

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

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 (DisksClient disksClient = DisksClient.create()) {
   InsertDiskRequest request =
       InsertDiskRequest.newBuilder()
           .setDiskResource(Disk.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSourceImage("sourceImage-105174528")
           .setZone("zone3744684")
           .build();
   Operation response = disksClient.insertAsync(request).get();
 }
 
Parameter
NameDescription
requestInsertDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertAsync(String project, String zone, Disk diskResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, Disk diskResource)

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Disk diskResource = Disk.newBuilder().build();
   Operation response = disksClient.insertAsync(project, zone, diskResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskResourceDisk

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertDiskRequest,Operation> insertCallable()

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

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 (DisksClient disksClient = DisksClient.create()) {
   InsertDiskRequest request =
       InsertDiskRequest.newBuilder()
           .setDiskResource(Disk.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSourceImage("sourceImage-105174528")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = disksClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<InsertDiskRequest,Operation>

insertOperationCallable()

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

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

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 (DisksClient disksClient = DisksClient.create()) {
   InsertDiskRequest request =
       InsertDiskRequest.newBuilder()
           .setDiskResource(Disk.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSourceImage("sourceImage-105174528")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<InsertDiskRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListDisksRequest request)

public final DisksClient.ListPagedResponse list(ListDisksRequest request)

Retrieves a list of persistent disks contained within the specified zone.

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 (DisksClient disksClient = DisksClient.create()) {
   ListDisksRequest request =
       ListDisksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (Disk element : disksClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListDisksRequest

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

Returns
TypeDescription
DisksClient.ListPagedResponse

list(String project, String zone)

public final DisksClient.ListPagedResponse list(String project, String zone)

Retrieves a list of persistent disks contained within the specified zone.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (Disk element : disksClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

Returns
TypeDescription
DisksClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListDisksRequest,DiskList> listCallable()

Retrieves a list of persistent disks contained within the specified zone.

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 (DisksClient disksClient = DisksClient.create()) {
   ListDisksRequest request =
       ListDisksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     DiskList response = disksClient.listCallable().call(request);
     for (Disk element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListDisksRequest,DiskList>

listPagedCallable()

public final UnaryCallable<ListDisksRequest,DisksClient.ListPagedResponse> listPagedCallable()

Retrieves a list of persistent disks contained within the specified zone.

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 (DisksClient disksClient = DisksClient.create()) {
   ListDisksRequest request =
       ListDisksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<Disk> future = disksClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Disk element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListDisksRequest,ListPagedResponse>

removeResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest request)

public final OperationFuture<Operation,Operation> removeResourcePoliciesAsync(RemoveResourcePoliciesDiskRequest request)

Removes resource policies from a disk.

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 (DisksClient disksClient = DisksClient.create()) {
   RemoveResourcePoliciesDiskRequest request =
       RemoveResourcePoliciesDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksRemoveResourcePoliciesRequestResource(
               DisksRemoveResourcePoliciesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = disksClient.removeResourcePoliciesAsync(request).get();
 }
 
Parameter
NameDescription
requestRemoveResourcePoliciesDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

removeResourcePoliciesAsync(String project, String zone, String disk, DisksRemoveResourcePoliciesRequest disksRemoveResourcePoliciesRequestResource)

public final OperationFuture<Operation,Operation> removeResourcePoliciesAsync(String project, String zone, String disk, DisksRemoveResourcePoliciesRequest disksRemoveResourcePoliciesRequestResource)

Removes resource policies from a disk.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   DisksRemoveResourcePoliciesRequest disksRemoveResourcePoliciesRequestResource =
       DisksRemoveResourcePoliciesRequest.newBuilder().build();
   Operation response =
       disksClient
           .removeResourcePoliciesAsync(
               project, zone, disk, disksRemoveResourcePoliciesRequestResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskString

The disk name for this request.

disksRemoveResourcePoliciesRequestResourceDisksRemoveResourcePoliciesRequest

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

removeResourcePoliciesCallable()

public final UnaryCallable<RemoveResourcePoliciesDiskRequest,Operation> removeResourcePoliciesCallable()

Removes resource policies from a disk.

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 (DisksClient disksClient = DisksClient.create()) {
   RemoveResourcePoliciesDiskRequest request =
       RemoveResourcePoliciesDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksRemoveResourcePoliciesRequestResource(
               DisksRemoveResourcePoliciesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future =
       disksClient.removeResourcePoliciesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<RemoveResourcePoliciesDiskRequest,Operation>

removeResourcePoliciesOperationCallable()

public final OperationCallable<RemoveResourcePoliciesDiskRequest,Operation,Operation> removeResourcePoliciesOperationCallable()

Removes resource policies from a disk.

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 (DisksClient disksClient = DisksClient.create()) {
   RemoveResourcePoliciesDiskRequest request =
       RemoveResourcePoliciesDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksRemoveResourcePoliciesRequestResource(
               DisksRemoveResourcePoliciesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.removeResourcePoliciesOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<RemoveResourcePoliciesDiskRequest,Operation,Operation>

resizeAsync(ResizeDiskRequest request)

public final OperationFuture<Operation,Operation> resizeAsync(ResizeDiskRequest request)

Resizes the specified persistent disk. You can only increase the size of the disk.

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 (DisksClient disksClient = DisksClient.create()) {
   ResizeDiskRequest request =
       ResizeDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksResizeRequestResource(DisksResizeRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = disksClient.resizeAsync(request).get();
 }
 
Parameter
NameDescription
requestResizeDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

resizeAsync(String project, String zone, String disk, DisksResizeRequest disksResizeRequestResource)

public final OperationFuture<Operation,Operation> resizeAsync(String project, String zone, String disk, DisksResizeRequest disksResizeRequestResource)

Resizes the specified persistent disk. You can only increase the size of the disk.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String disk = "disk3083677";
   DisksResizeRequest disksResizeRequestResource = DisksResizeRequest.newBuilder().build();
   Operation response =
       disksClient.resizeAsync(project, zone, disk, disksResizeRequestResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskString

The name of the persistent disk.

disksResizeRequestResourceDisksResizeRequest

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

resizeCallable()

public final UnaryCallable<ResizeDiskRequest,Operation> resizeCallable()

Resizes the specified persistent disk. You can only increase the size of the disk.

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 (DisksClient disksClient = DisksClient.create()) {
   ResizeDiskRequest request =
       ResizeDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksResizeRequestResource(DisksResizeRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = disksClient.resizeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ResizeDiskRequest,Operation>

resizeOperationCallable()

public final OperationCallable<ResizeDiskRequest,Operation,Operation> resizeOperationCallable()

Resizes the specified persistent disk. You can only increase the size of the disk.

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 (DisksClient disksClient = DisksClient.create()) {
   ResizeDiskRequest request =
       ResizeDiskRequest.newBuilder()
           .setDisk("disk3083677")
           .setDisksResizeRequestResource(DisksResizeRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.resizeOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<ResizeDiskRequest,Operation,Operation>

setIamPolicy(SetIamPolicyDiskRequest request)

public final Policy setIamPolicy(SetIamPolicyDiskRequest request)

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

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 (DisksClient disksClient = DisksClient.create()) {
   SetIamPolicyDiskRequest request =
       SetIamPolicyDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetPolicyRequestResource(ZoneSetPolicyRequest.newBuilder().build())
           .build();
   Policy response = disksClient.setIamPolicy(request);
 }
 
Parameter
NameDescription
requestSetIamPolicyDiskRequest

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

Returns
TypeDescription
Policy

setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

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

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   ZoneSetPolicyRequest zoneSetPolicyRequestResource = ZoneSetPolicyRequest.newBuilder().build();
   Policy response =
       disksClient.setIamPolicy(project, zone, resource, zoneSetPolicyRequestResource);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

zoneSetPolicyRequestResourceZoneSetPolicyRequest

The body resource for this request

Returns
TypeDescription
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyDiskRequest,Policy> setIamPolicyCallable()

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

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 (DisksClient disksClient = DisksClient.create()) {
   SetIamPolicyDiskRequest request =
       SetIamPolicyDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetPolicyRequestResource(ZoneSetPolicyRequest.newBuilder().build())
           .build();
   ApiFuture<Policy> future = disksClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<SetIamPolicyDiskRequest,Policy>

setLabelsAsync(SetLabelsDiskRequest request)

public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsDiskRequest request)

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

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 (DisksClient disksClient = DisksClient.create()) {
   SetLabelsDiskRequest request =
       SetLabelsDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetLabelsRequestResource(ZoneSetLabelsRequest.newBuilder().build())
           .build();
   Operation response = disksClient.setLabelsAsync(request).get();
 }
 
Parameter
NameDescription
requestSetLabelsDiskRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

setLabelsAsync(String project, String zone, String resource, ZoneSetLabelsRequest zoneSetLabelsRequestResource)

public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String zone, String resource, ZoneSetLabelsRequest zoneSetLabelsRequestResource)

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   ZoneSetLabelsRequest zoneSetLabelsRequestResource = ZoneSetLabelsRequest.newBuilder().build();
   Operation response =
       disksClient.setLabelsAsync(project, zone, resource, zoneSetLabelsRequestResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

zoneSetLabelsRequestResourceZoneSetLabelsRequest

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

setLabelsCallable()

public final UnaryCallable<SetLabelsDiskRequest,Operation> setLabelsCallable()

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

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 (DisksClient disksClient = DisksClient.create()) {
   SetLabelsDiskRequest request =
       SetLabelsDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetLabelsRequestResource(ZoneSetLabelsRequest.newBuilder().build())
           .build();
   ApiFuture<Operation> future = disksClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<SetLabelsDiskRequest,Operation>

setLabelsOperationCallable()

public final OperationCallable<SetLabelsDiskRequest,Operation,Operation> setLabelsOperationCallable()

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

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 (DisksClient disksClient = DisksClient.create()) {
   SetLabelsDiskRequest request =
       SetLabelsDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetLabelsRequestResource(ZoneSetLabelsRequest.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       disksClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<SetLabelsDiskRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsDiskRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsDiskRequest request)

Returns permissions that a caller has on the specified 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 (DisksClient disksClient = DisksClient.create()) {
   TestIamPermissionsDiskRequest request =
       TestIamPermissionsDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   TestPermissionsResponse response = disksClient.testIamPermissions(request);
 }
 
Parameter
NameDescription
requestTestIamPermissionsDiskRequest

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

Returns
TypeDescription
TestPermissionsResponse

testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified 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 (DisksClient disksClient = DisksClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       disksClient.testIamPermissions(project, zone, resource, testPermissionsRequestResource);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

Returns
TypeDescription
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsDiskRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified 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 (DisksClient disksClient = DisksClient.create()) {
   TestIamPermissionsDiskRequest request =
       TestIamPermissionsDiskRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<TestPermissionsResponse> future =
       disksClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<TestIamPermissionsDiskRequest,TestPermissionsResponse>