Class RegionDiskTypesClient (1.44.0)

Version 1.44.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

Service Description: The RegionDiskTypes 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String diskType = "diskType279771767";
   DiskType response = regionDiskTypesClient.get(project, region, diskType);
 }
 

Note: close() needs to be called on the RegionDiskTypesClient 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
Get	Returns the specified regional disk type.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRegionDiskTypeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String 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 regional 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(ListRegionDiskTypesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()

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 RegionDiskTypesSettings 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
 RegionDiskTypesSettings regionDiskTypesSettings =
     RegionDiskTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionDiskTypesClient regionDiskTypesClient =
     RegionDiskTypesClient.create(regionDiskTypesSettings);
 

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
 RegionDiskTypesSettings regionDiskTypesSettings =
     RegionDiskTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionDiskTypesClient regionDiskTypesClient =
     RegionDiskTypesClient.create(regionDiskTypesSettings);
 

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

Inheritance

java.lang.Object > RegionDiskTypesClient

Static Methods

create()

public static final RegionDiskTypesClient create()

Constructs an instance of RegionDiskTypesClient with default settings.

Returns
Type	Description
RegionDiskTypesClient

Exceptions
Type	Description
IOException

create(RegionDiskTypesSettings settings)

public static final RegionDiskTypesClient create(RegionDiskTypesSettings settings)

Constructs an instance of RegionDiskTypesClient, 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	RegionDiskTypesSettings

Returns
Type	Description
RegionDiskTypesClient

Exceptions
Type	Description
IOException

create(RegionDiskTypesStub stub)

public static final RegionDiskTypesClient create(RegionDiskTypesStub stub)

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

Parameter
Name	Description
stub	RegionDiskTypesStub

Returns
Type	Description
RegionDiskTypesClient

Constructors

RegionDiskTypesClient(RegionDiskTypesSettings settings)

protected RegionDiskTypesClient(RegionDiskTypesSettings settings)

Constructs an instance of RegionDiskTypesClient, 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	RegionDiskTypesSettings

RegionDiskTypesClient(RegionDiskTypesStub stub)

protected RegionDiskTypesClient(RegionDiskTypesStub stub)

Parameter
Name	Description
stub	RegionDiskTypesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

get(GetRegionDiskTypeRequest request)

public final DiskType get(GetRegionDiskTypeRequest request)

Returns the specified regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   GetRegionDiskTypeRequest request =
       GetRegionDiskTypeRequest.newBuilder()
           .setDiskType("diskType279771767")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   DiskType response = regionDiskTypesClient.get(request);
 }
 

Parameter
Name	Description
request	GetRegionDiskTypeRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
DiskType

get(String project, String region, String diskType)

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

Returns the specified regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String diskType = "diskType279771767";
   DiskType response = regionDiskTypesClient.get(project, region, diskType);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
diskType	String Name of the disk type to return.

Returns
Type	Description
DiskType

getCallable()

public final UnaryCallable<GetRegionDiskTypeRequest,DiskType> getCallable()

Returns the specified regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   GetRegionDiskTypeRequest request =
       GetRegionDiskTypeRequest.newBuilder()
           .setDiskType("diskType279771767")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<DiskType> future = regionDiskTypesClient.getCallable().futureCall(request);
   // Do something.
   DiskType response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetRegionDiskTypeRequest,DiskType>

getSettings()

public final RegionDiskTypesSettings getSettings()

Returns
Type	Description
RegionDiskTypesSettings

getStub()

public RegionDiskTypesStub getStub()

Returns
Type	Description
RegionDiskTypesStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListRegionDiskTypesRequest request)

public final RegionDiskTypesClient.ListPagedResponse list(ListRegionDiskTypesRequest request)

Retrieves a list of regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   ListRegionDiskTypesRequest request =
       ListRegionDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (DiskType element : regionDiskTypesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListRegionDiskTypesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
RegionDiskTypesClient.ListPagedResponse

list(String project, String region)

public final RegionDiskTypesClient.ListPagedResponse list(String project, String region)

Retrieves a list of regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (DiskType element : regionDiskTypesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.

Returns
Type	Description
RegionDiskTypesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionDiskTypesRequest,RegionDiskTypeList> listCallable()

Retrieves a list of regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   ListRegionDiskTypesRequest request =
       ListRegionDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RegionDiskTypeList response = regionDiskTypesClient.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<ListRegionDiskTypesRequest,RegionDiskTypeList>

listPagedCallable()

public final UnaryCallable<ListRegionDiskTypesRequest,RegionDiskTypesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of regional 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 (RegionDiskTypesClient regionDiskTypesClient = RegionDiskTypesClient.create()) {
   ListRegionDiskTypesRequest request =
       ListRegionDiskTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<DiskType> future = regionDiskTypesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (DiskType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRegionDiskTypesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()