com.google.cloud.compute.v1

Class RegionClient

java.lang.Object

com.google.cloud.compute.v1.RegionClient

All Implemented Interfaces:

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

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

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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:

 
 try (RegionClient regionClient = RegionClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   Region response = regionClient.getRegion(region);
 }
 
 

Note: close() needs to be called on the regionClient 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 RegionSettings to create(). For example:

To customize credentials:

 
 RegionSettings regionSettings =
     RegionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionClient regionClient =
     RegionClient.create(regionSettings);
 
 

To customize the endpoint:

 
 RegionSettings regionSettings =
     RegionSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionClient regionClient =
     RegionClient.create(regionSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionClient.ListRegionsFixedSizeCollection
static class	RegionClient.ListRegionsPage
static class	RegionClient.ListRegionsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionClient(RegionSettings settings) Constructs an instance of RegionClient, using the given settings.
protected	RegionClient(RegionStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionClient	create() Constructs an instance of RegionClient with default settings.
static RegionClient	create(RegionSettings settings) Constructs an instance of RegionClient, using the given settings.
static RegionClient	create(RegionStub stub) Constructs an instance of RegionClient, using the given stub for making calls.
Region	getRegion(GetRegionHttpRequest request) Returns the specified Region resource.
Region	getRegion(ProjectRegionName region) Returns the specified Region resource.
Region	getRegion(String region) Returns the specified Region resource.
com.google.api.gax.rpc.UnaryCallable<GetRegionHttpRequest,Region>	getRegionCallable() Returns the specified Region resource.
RegionSettings	getSettings()
RegionStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RegionClient.ListRegionsPagedResponse	listRegions(ListRegionsHttpRequest request) Retrieves the list of region resources available to the specified project.
RegionClient.ListRegionsPagedResponse	listRegions(ProjectName project) Retrieves the list of region resources available to the specified project.
RegionClient.ListRegionsPagedResponse	listRegions(String project) Retrieves the list of region resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRegionsHttpRequest,RegionList>	listRegionsCallable() Retrieves the list of region resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRegionsHttpRequest,RegionClient.ListRegionsPagedResponse>	listRegionsPagedCallable() Retrieves the list of region resources 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

RegionClient

protected RegionClient(RegionSettings settings)
                throws IOException

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

RegionClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected RegionClient(RegionStub stub)

Method Detail

create

public static final RegionClient create()
                                 throws IOException

Constructs an instance of RegionClient with default settings.

Throws:

IOException

create

public static final RegionClient create(RegionSettings settings)
                                 throws IOException

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final RegionClient create(RegionStub stub)

Constructs an instance of RegionClient, using the given stub for making calls. This is for advanced usage - prefer to use RegionSettings}.

getSettings

public final RegionSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public RegionStub getStub()

getRegion

@BetaApi
public final Region getRegion(ProjectRegionName region)

Returns the specified Region resource. Gets a list of available regions by making a list() request.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   Region response = regionClient.getRegion(region);
 }
 

Parameters:

region - Name of the region resource to return.

Throws:

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

getRegion

@BetaApi
public final Region getRegion(String region)

Returns the specified Region resource. Gets a list of available regions by making a list() request.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   Region response = regionClient.getRegion(region.toString());
 }
 

Parameters:

region - Name of the region resource to return.

Throws:

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

getRegion

@BetaApi
public final Region getRegion(GetRegionHttpRequest request)

Returns the specified Region resource. Gets a list of available regions by making a list() request.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   GetRegionHttpRequest request = GetRegionHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   Region response = regionClient.getRegion(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

getRegionCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetRegionHttpRequest,Region> getRegionCallable()

Returns the specified Region resource. Gets a list of available regions by making a list() request.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   GetRegionHttpRequest request = GetRegionHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<Region> future = regionClient.getRegionCallable().futureCall(request);
   // Do something
   Region response = future.get();
 }
 

listRegions

@BetaApi
public final RegionClient.ListRegionsPagedResponse listRegions(ProjectName project)

Retrieves the list of region resources available to the specified project.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Region element : regionClient.listRegions(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listRegions

@BetaApi
public final RegionClient.ListRegionsPagedResponse listRegions(String project)

Retrieves the list of region resources available to the specified project.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Region element : regionClient.listRegions(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listRegions

@BetaApi
public final RegionClient.ListRegionsPagedResponse listRegions(ListRegionsHttpRequest request)

Retrieves the list of region resources available to the specified project.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListRegionsHttpRequest request = ListRegionsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Region element : regionClient.listRegions(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

listRegionsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionsHttpRequest,RegionClient.ListRegionsPagedResponse> listRegionsPagedCallable()

Retrieves the list of region resources available to the specified project.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListRegionsHttpRequest request = ListRegionsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListRegionsPagedResponse> future = regionClient.listRegionsPagedCallable().futureCall(request);
   // Do something
   for (Region element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionsHttpRequest,RegionList> listRegionsCallable()

Retrieves the list of region resources available to the specified project.

Sample code:

 try (RegionClient regionClient = RegionClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListRegionsHttpRequest request = ListRegionsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     RegionList response = regionClient.listRegionsCallable().call(request);
     for (Region 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