RegionDiskTypesClient (Google Compute Engine 1.59.0 API)

java.lang.Object
- com.google.cloud.compute.v1.RegionDiskTypesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class RegionDiskTypesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegionDiskTypesClient.ListFixedSizeCollection`
`static class`	`RegionDiskTypesClient.ListPage`
`static class`	`RegionDiskTypesClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RegionDiskTypesClient(RegionDiskTypesSettings settings)` Constructs an instance of RegionDiskTypesClient, using the given settings.
`protected`	`RegionDiskTypesClient(RegionDiskTypesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static RegionDiskTypesClient`	`create()` Constructs an instance of RegionDiskTypesClient with default settings.
`static RegionDiskTypesClient`	`create(RegionDiskTypesSettings settings)` Constructs an instance of RegionDiskTypesClient, using the given settings.
`static RegionDiskTypesClient`	`create(RegionDiskTypesStub stub)` Constructs an instance of RegionDiskTypesClient, using the given stub for making calls.
`DiskType`	`get(GetRegionDiskTypeRequest request)` Returns the specified regional disk type.
`DiskType`	`get(String project, String region, String diskType)` Returns the specified regional disk type.
`com.google.api.gax.rpc.UnaryCallable<GetRegionDiskTypeRequest,DiskType>`	`getCallable()` Returns the specified regional disk type.
`RegionDiskTypesSettings`	`getSettings()`
`RegionDiskTypesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`RegionDiskTypesClient.ListPagedResponse`	`list(ListRegionDiskTypesRequest request)` Retrieves a list of regional disk types available to the specified project.
`RegionDiskTypesClient.ListPagedResponse`	`list(String project, String region)` Retrieves a list of regional disk types available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListRegionDiskTypesRequest,RegionDiskTypeList>`	`listCallable()` Retrieves a list of regional disk types available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListRegionDiskTypesRequest,RegionDiskTypesClient.ListPagedResponse>`	`listPagedCallable()` Retrieves a list of regional disk types available to the specified project.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RegionDiskTypesClient
```
protected RegionDiskTypesClient(RegionDiskTypesSettings settings)
                         throws IOException
```
  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.
  
  Throws:
  
  IOException
- RegionDiskTypesClient
```
protected RegionDiskTypesClient(RegionDiskTypesStub stub)
```

Method Detail

create

public static final RegionDiskTypesClient create()
                                          throws IOException

Constructs an instance of RegionDiskTypesClient with default settings.

Throws:: IOException

create
```
public static final RegionDiskTypesClient create(RegionDiskTypesSettings settings)
                                          throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final RegionDiskTypesSettings getSettings()

getStub
```
public RegionDiskTypesStub getStub()
```

get

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:: project - Project ID for this request.; region - The name of the region for this request.; diskType - Name of the disk type to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCallable

public final com.google.api.gax.rpc.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();
 }

list

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:: project - Project ID for this request.; region - The name of the region for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

list

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class RegionDiskTypesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegionDiskTypesClient

RegionDiskTypesClient

Method Detail

create

create

create

getSettings

getStub

get

get

getCallable

list

list

listPagedCallable

listCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination