Class DiskTypesClient (1.32.0) 

public class DiskTypesClient implements BackgroundResource

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

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

Implements

BackgroundResource

Static Methods

create()

public static final DiskTypesClient create()

Constructs an instance of DiskTypesClient with default settings.

Returns
TypeDescription
DiskTypesClient
Exceptions
TypeDescription
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
NameDescription
settingsDiskTypesSettings
Returns
TypeDescription
DiskTypesClient
Exceptions
TypeDescription
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
NameDescription
stubDiskTypesStub
Returns
TypeDescription
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
NameDescription
settingsDiskTypesSettings

DiskTypesClient(DiskTypesStub stub)

protected DiskTypesClient(DiskTypesStub stub)
Parameter
NameDescription
stubDiskTypesStub

Methods

aggregatedList(AggregatedListDiskTypesRequest request)

public final DiskTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListDiskTypesRequest request)

Retrieves an aggregated list of disk types.

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)
           .build();
   for (Map.Entry<String, DiskTypesScopedList> element :
       diskTypesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
requestAggregatedListDiskTypesRequest

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

Returns
TypeDescription
DiskTypesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final DiskTypesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of disk types.

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
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
DiskTypesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListDiskTypesRequest,DiskTypeAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of disk types.

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)
           .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
TypeDescription
UnaryCallable<AggregatedListDiskTypesRequest,DiskTypeAggregatedList>

aggregatedListPagedCallable()

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

Retrieves an aggregated list of disk types.

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)
           .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
TypeDescription
UnaryCallable<AggregatedListDiskTypesRequest,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()

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
NameDescription
requestGetDiskTypeRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

diskTypeString

Name of the disk type to return.

Returns
TypeDescription
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
TypeDescription
UnaryCallable<GetDiskTypeRequest,DiskType>

getSettings()

public final DiskTypesSettings getSettings()
Returns
TypeDescription
DiskTypesSettings

getStub()

public DiskTypesStub getStub()
Returns
TypeDescription
DiskTypesStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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
NameDescription
requestListDiskTypesRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListDiskTypesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()