com.google.cloud.compute.v1

Class RegionZonesClient

java.lang.Object

com.google.cloud.compute.v1.RegionZonesClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: The RegionZones 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 (RegionZonesClient regionZonesClient = RegionZonesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Zone element : regionZonesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Note: close() needs to be called on the RegionZonesClient 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
List	Retrieves the list of Zone resources under the specific region available to the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRegionZonesRequest 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 RegionZonesSettings 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
 RegionZonesSettings regionZonesSettings =
     RegionZonesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionZonesClient regionZonesClient = RegionZonesClient.create(regionZonesSettings);
 

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
 RegionZonesSettings regionZonesSettings =
     RegionZonesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionZonesClient regionZonesClient = RegionZonesClient.create(regionZonesSettings);
 

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	RegionZonesClient.ListFixedSizeCollection
static class	RegionZonesClient.ListPage
static class	RegionZonesClient.ListPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionZonesClient(RegionZonesSettings settings) Constructs an instance of RegionZonesClient, using the given settings.
protected	RegionZonesClient(RegionZonesStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionZonesClient	create() Constructs an instance of RegionZonesClient with default settings.
static RegionZonesClient	create(RegionZonesSettings settings) Constructs an instance of RegionZonesClient, using the given settings.
static RegionZonesClient	create(RegionZonesStub stub) Constructs an instance of RegionZonesClient, using the given stub for making calls.
RegionZonesSettings	getSettings()
RegionZonesStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RegionZonesClient.ListPagedResponse	list(ListRegionZonesRequest request) Retrieves the list of Zone resources under the specific region available to the specified project.
RegionZonesClient.ListPagedResponse	list(String project, String region) Retrieves the list of Zone resources under the specific region available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRegionZonesRequest,ZoneList>	listCallable() Retrieves the list of Zone resources under the specific region available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRegionZonesRequest,RegionZonesClient.ListPagedResponse>	listPagedCallable() Retrieves the list of Zone resources under the specific region 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

RegionZonesClient

protected RegionZonesClient(RegionZonesSettings settings)
                     throws IOException

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

RegionZonesClient

protected RegionZonesClient(RegionZonesStub stub)

Method Detail

create

public static final RegionZonesClient create()
                                      throws IOException

Constructs an instance of RegionZonesClient with default settings.

Throws:

IOException

create

public static final RegionZonesClient create(RegionZonesSettings settings)
                                      throws IOException

Constructs an instance of RegionZonesClient, 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 RegionZonesClient create(RegionZonesStub stub)

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

getSettings

public final RegionZonesSettings getSettings()

getStub

public RegionZonesStub getStub()

list

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

Retrieves the list of Zone resources under the specific region 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 (RegionZonesClient regionZonesClient = RegionZonesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Zone element : regionZonesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

region - Region for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

list

public final RegionZonesClient.ListPagedResponse list(ListRegionZonesRequest request)

Retrieves the list of Zone resources under the specific region 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 (RegionZonesClient regionZonesClient = RegionZonesClient.create()) {
   ListRegionZonesRequest request =
       ListRegionZonesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (Zone element : regionZonesClient.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<ListRegionZonesRequest,RegionZonesClient.ListPagedResponse> listPagedCallable()

Retrieves the list of Zone resources under the specific region 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 (RegionZonesClient regionZonesClient = RegionZonesClient.create()) {
   ListRegionZonesRequest request =
       ListRegionZonesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Zone> future = regionZonesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Zone element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRegionZonesRequest,ZoneList> listCallable()

Retrieves the list of Zone resources under the specific region 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 (RegionZonesClient regionZonesClient = RegionZonesClient.create()) {
   ListRegionZonesRequest request =
       ListRegionZonesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ZoneList response = regionZonesClient.listCallable().call(request);
     for (Zone 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