Class DiskTypesClient (1.64.0)

GitHub RepositoryProduct Reference

Service Description: The DiskTypes 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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String diskType = "diskType279771767";
   DiskType response = diskTypesClient.get(project, zone, diskType);
 }

Note: close() needs to be called on the DiskTypesClient 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

AggregatedList

Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

  • aggregatedList(AggregatedListDiskTypesRequest request)

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

  • aggregatedList(String project)

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

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Get

Returns the specified disk type.

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

  • get(GetDiskTypeRequest 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 zone, String diskType)

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

  • getCallable()

List

Retrieves a list of disk types available to the specified project.

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

  • list(ListDiskTypesRequest 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 zone)

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()

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 DiskTypesSettings 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
 DiskTypesSettings diskTypesSettings =
     DiskTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DiskTypesClient diskTypesClient = DiskTypesClient.create(diskTypesSettings);

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
 DiskTypesSettings diskTypesSettings =
     DiskTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 DiskTypesClient diskTypesClient = DiskTypesClient.create(diskTypesSettings);

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

Inheritance

java.lang.Object > DiskTypesClient

Static Methods

create()

public static final DiskTypesClient create()

Constructs an instance of DiskTypesClient with default settings.

Returns
Type Description
DiskTypesClient
Exceptions
Type Description
IOException

create(DiskTypesSettings settings)

public static final DiskTypesClient create(DiskTypesSettings settings)

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

create(DiskTypesStub stub)

public static final DiskTypesClient create(DiskTypesStub stub)

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

Parameter
Name Description
stub DiskTypesStub
Returns
Type Description
DiskTypesClient

Constructors

DiskTypesClient(DiskTypesSettings settings)

protected DiskTypesClient(DiskTypesSettings settings)

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

DiskTypesClient(DiskTypesStub stub)

protected DiskTypesClient(DiskTypesStub stub)
Parameter
Name Description
stub DiskTypesStub

Methods

aggregatedList(AggregatedListDiskTypesRequest request)

public final DiskTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListDiskTypesRequest request)

Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   AggregatedListDiskTypesRequest request =
       AggregatedListDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, DiskTypesScopedList> element :
       diskTypesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListDiskTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DiskTypesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final DiskTypesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, DiskTypesScopedList> element :
       diskTypesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
DiskTypesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListDiskTypesRequest,DiskTypeAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   AggregatedListDiskTypesRequest request =
       AggregatedListDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     DiskTypeAggregatedList response = diskTypesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, DiskTypesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListDiskTypesRequest,DiskTypeAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListDiskTypesRequest,DiskTypesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   AggregatedListDiskTypesRequest request =
       AggregatedListDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, DiskTypesScopedList>> future =
       diskTypesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, DiskTypesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListDiskTypesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

get(GetDiskTypeRequest request)

public final DiskType get(GetDiskTypeRequest request)

Returns the specified disk type.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   GetDiskTypeRequest request =
       GetDiskTypeRequest.newBuilder()
           .setDiskType("diskType279771767")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   DiskType response = diskTypesClient.get(request);
 }
Parameter
Name Description
request GetDiskTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DiskType

get(String project, String zone, String diskType)

public final DiskType get(String project, String zone, String diskType)

Returns the specified disk type.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String diskType = "diskType279771767";
   DiskType response = diskTypesClient.get(project, zone, diskType);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The name of the zone for this request.
diskType String

Name of the disk type to return.
Returns
Type Description
DiskType

getCallable()

public final UnaryCallable<GetDiskTypeRequest,DiskType> getCallable()

Returns the specified disk type.

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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   GetDiskTypeRequest request =
       GetDiskTypeRequest.newBuilder()
           .setDiskType("diskType279771767")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<DiskType> future = diskTypesClient.getCallable().futureCall(request);
   // Do something.
   DiskType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDiskTypeRequest,DiskType>

getSettings()

public final DiskTypesSettings getSettings()
Returns
Type Description
DiskTypesSettings

getStub()

public DiskTypesStub getStub()
Returns
Type Description
DiskTypesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListDiskTypesRequest request)

public final DiskTypesClient.ListPagedResponse list(ListDiskTypesRequest request)

Retrieves a list of disk types available to the specified 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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   ListDiskTypesRequest request =
       ListDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (DiskType element : diskTypesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDiskTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DiskTypesClient.ListPagedResponse

list(String project, String zone)

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

Retrieves a list of disk types available to the specified 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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (DiskType element : diskTypesClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The name of the zone for this request.
Returns
Type Description
DiskTypesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListDiskTypesRequest,DiskTypeList> listCallable()

Retrieves a list of disk types available to the specified 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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   ListDiskTypesRequest request =
       ListDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     DiskTypeList response = diskTypesClient.listCallable().call(request);
     for (DiskType element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDiskTypesRequest,DiskTypeList>

listPagedCallable()

public final UnaryCallable<ListDiskTypesRequest,DiskTypesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of disk types available to the specified 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 (DiskTypesClient diskTypesClient = DiskTypesClient.create()) {
   ListDiskTypesRequest request =
       ListDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<DiskType> future = diskTypesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (DiskType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDiskTypesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()