StoragePoolTypesClient (Google Compute Engine 1.59.0 API)

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

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

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

Service Description: The StoragePoolTypes 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String storagePoolType = "storagePoolType-354080495";
   StoragePoolType response = storagePoolTypesClient.get(project, zone, storagePoolType);
 }

Note: close() needs to be called on the StoragePoolTypesClient 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 storage pool 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(AggregatedListStoragePoolTypesRequest 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 storage pool type.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetStoragePoolTypeRequest 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 storagePoolType) 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 storage pool 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(ListStoragePoolTypesRequest 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 StoragePoolTypesSettings 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
 StoragePoolTypesSettings storagePoolTypesSettings =
     StoragePoolTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 StoragePoolTypesClient storagePoolTypesClient =
     StoragePoolTypesClient.create(storagePoolTypesSettings);

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
 StoragePoolTypesSettings storagePoolTypesSettings =
     StoragePoolTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 StoragePoolTypesClient storagePoolTypesClient =
     StoragePoolTypesClient.create(storagePoolTypesSettings);

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`	`StoragePoolTypesClient.AggregatedListFixedSizeCollection`
`static class`	`StoragePoolTypesClient.AggregatedListPage`
`static class`	`StoragePoolTypesClient.AggregatedListPagedResponse`
`static class`	`StoragePoolTypesClient.ListFixedSizeCollection`
`static class`	`StoragePoolTypesClient.ListPage`
`static class`	`StoragePoolTypesClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`StoragePoolTypesClient(StoragePoolTypesSettings settings)` Constructs an instance of StoragePoolTypesClient, using the given settings.
`protected`	`StoragePoolTypesClient(StoragePoolTypesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StoragePoolTypesClient.AggregatedListPagedResponse`	`aggregatedList(AggregatedListStoragePoolTypesRequest request)` Retrieves an aggregated list of storage pool types.
`StoragePoolTypesClient.AggregatedListPagedResponse`	`aggregatedList(String project)` Retrieves an aggregated list of storage pool types.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListStoragePoolTypesRequest,StoragePoolTypeAggregatedList>`	`aggregatedListCallable()` Retrieves an aggregated list of storage pool types.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListStoragePoolTypesRequest,StoragePoolTypesClient.AggregatedListPagedResponse>`	`aggregatedListPagedCallable()` Retrieves an aggregated list of storage pool types.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static StoragePoolTypesClient`	`create()` Constructs an instance of StoragePoolTypesClient with default settings.
`static StoragePoolTypesClient`	`create(StoragePoolTypesSettings settings)` Constructs an instance of StoragePoolTypesClient, using the given settings.
`static StoragePoolTypesClient`	`create(StoragePoolTypesStub stub)` Constructs an instance of StoragePoolTypesClient, using the given stub for making calls.
`StoragePoolType`	`get(GetStoragePoolTypeRequest request)` Returns the specified storage pool type.
`StoragePoolType`	`get(String project, String zone, String storagePoolType)` Returns the specified storage pool type.
`com.google.api.gax.rpc.UnaryCallable<GetStoragePoolTypeRequest,StoragePoolType>`	`getCallable()` Returns the specified storage pool type.
`StoragePoolTypesSettings`	`getSettings()`
`StoragePoolTypesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`StoragePoolTypesClient.ListPagedResponse`	`list(ListStoragePoolTypesRequest request)` Retrieves a list of storage pool types available to the specified project.
`StoragePoolTypesClient.ListPagedResponse`	`list(String project, String zone)` Retrieves a list of storage pool types available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListStoragePoolTypesRequest,StoragePoolTypeList>`	`listCallable()` Retrieves a list of storage pool types available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListStoragePoolTypesRequest,StoragePoolTypesClient.ListPagedResponse>`	`listPagedCallable()` Retrieves a list of storage pool 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
- StoragePoolTypesClient
```
protected StoragePoolTypesClient(StoragePoolTypesSettings settings)
                          throws IOException
```
  Constructs an instance of StoragePoolTypesClient, 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
- StoragePoolTypesClient
```
protected StoragePoolTypesClient(StoragePoolTypesStub stub)
```

Method Detail

create

public static final StoragePoolTypesClient create()
                                           throws IOException

Constructs an instance of StoragePoolTypesClient with default settings.

Throws:: IOException

create
```
public static final StoragePoolTypesClient create(StoragePoolTypesSettings settings)
                                           throws IOException
```
Constructs an instance of StoragePoolTypesClient, 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 StoragePoolTypesClient create(StoragePoolTypesStub stub)
```
Constructs an instance of StoragePoolTypesClient, using the given stub for making calls. This is for advanced usage - prefer using create(StoragePoolTypesSettings).

getSettings

public final StoragePoolTypesSettings getSettings()

getStub
```
public StoragePoolTypesStub getStub()
```

aggregatedList

public final StoragePoolTypesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, StoragePoolTypesScopedList> element :
       storagePoolTypesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedList

public final StoragePoolTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListStoragePoolTypesRequest request)

Retrieves an aggregated list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   AggregatedListStoragePoolTypesRequest request =
       AggregatedListStoragePoolTypesRequest.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, StoragePoolTypesScopedList> element :
       storagePoolTypesClient.aggregatedList(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

aggregatedListPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<AggregatedListStoragePoolTypesRequest,StoragePoolTypesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   AggregatedListStoragePoolTypesRequest request =
       AggregatedListStoragePoolTypesRequest.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, StoragePoolTypesScopedList>> future =
       storagePoolTypesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, StoragePoolTypesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListCallable

public final com.google.api.gax.rpc.UnaryCallable<AggregatedListStoragePoolTypesRequest,StoragePoolTypeAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   AggregatedListStoragePoolTypesRequest request =
       AggregatedListStoragePoolTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     StoragePoolTypeAggregatedList response =
         storagePoolTypesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, StoragePoolTypesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

get

public final StoragePoolType get(String project,
                                 String zone,
                                 String storagePoolType)

Returns the specified storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String storagePoolType = "storagePoolType-354080495";
   StoragePoolType response = storagePoolTypesClient.get(project, zone, storagePoolType);
 }

Parameters:: project - Project ID for this request.; zone - The name of the zone for this request.; storagePoolType - Name of the storage pool type to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

public final StoragePoolType get(GetStoragePoolTypeRequest request)

Returns the specified storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   GetStoragePoolTypeRequest request =
       GetStoragePoolTypeRequest.newBuilder()
           .setProject("project-309310695")
           .setStoragePoolType("storagePoolType-354080495")
           .setZone("zone3744684")
           .build();
   StoragePoolType response = storagePoolTypesClient.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<GetStoragePoolTypeRequest,StoragePoolType> getCallable()

Returns the specified storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   GetStoragePoolTypeRequest request =
       GetStoragePoolTypeRequest.newBuilder()
           .setProject("project-309310695")
           .setStoragePoolType("storagePoolType-354080495")
           .setZone("zone3744684")
           .build();
   ApiFuture<StoragePoolType> future = storagePoolTypesClient.getCallable().futureCall(request);
   // Do something.
   StoragePoolType response = future.get();
 }

list

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

Retrieves a list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (StoragePoolType element : storagePoolTypesClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.; zone - The name of the zone for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

list

public final StoragePoolTypesClient.ListPagedResponse list(ListStoragePoolTypesRequest request)

Retrieves a list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   ListStoragePoolTypesRequest request =
       ListStoragePoolTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (StoragePoolType element : storagePoolTypesClient.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<ListStoragePoolTypesRequest,StoragePoolTypesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   ListStoragePoolTypesRequest request =
       ListStoragePoolTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<StoragePoolType> future =
       storagePoolTypesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (StoragePoolType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListStoragePoolTypesRequest,StoragePoolTypeList> listCallable()

Retrieves a list of storage pool 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 (StoragePoolTypesClient storagePoolTypesClient = StoragePoolTypesClient.create()) {
   ListStoragePoolTypesRequest request =
       ListStoragePoolTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     StoragePoolTypeList response = storagePoolTypesClient.listCallable().call(request);
     for (StoragePoolType 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 StoragePoolTypesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StoragePoolTypesClient

StoragePoolTypesClient

Method Detail

create

create

create

getSettings

getStub

aggregatedList

aggregatedList

aggregatedListPagedCallable

aggregatedListCallable

get

get

getCallable

list

list

listPagedCallable

listCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination