com.google.cloud.compute.v1

Class ZoneClient

java.lang.Object

com.google.cloud.compute.v1.ZoneClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class ZoneClient
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 (ZoneClient zoneClient = ZoneClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Zone response = zoneClient.getZone(zone);
 }
 
 

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

To customize credentials:

 
 ZoneSettings zoneSettings =
     ZoneSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ZoneClient zoneClient =
     ZoneClient.create(zoneSettings);
 
 

To customize the endpoint:

 
 ZoneSettings zoneSettings =
     ZoneSettings.newBuilder().setEndpoint(myEndpoint).build();
 ZoneClient zoneClient =
     ZoneClient.create(zoneSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZoneClient.ListZonesFixedSizeCollection
static class	ZoneClient.ListZonesPage
static class	ZoneClient.ListZonesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ZoneClient(ZoneSettings settings) Constructs an instance of ZoneClient, using the given settings.
protected	ZoneClient(ZoneStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ZoneClient	create() Constructs an instance of ZoneClient with default settings.
static ZoneClient	create(ZoneSettings settings) Constructs an instance of ZoneClient, using the given settings.
static ZoneClient	create(ZoneStub stub) Constructs an instance of ZoneClient, using the given stub for making calls.
ZoneSettings	getSettings()
ZoneStub	getStub()
Zone	getZone(GetZoneHttpRequest request) Returns the specified Zone resource.
Zone	getZone(ProjectZoneName zone) Returns the specified Zone resource.
Zone	getZone(String zone) Returns the specified Zone resource.
com.google.api.gax.rpc.UnaryCallable<GetZoneHttpRequest,Zone>	getZoneCallable() Returns the specified Zone resource.
boolean	isShutdown()
boolean	isTerminated()
ZoneClient.ListZonesPagedResponse	listZones(ListZonesHttpRequest request) Retrieves the list of Zone resources available to the specified project.
ZoneClient.ListZonesPagedResponse	listZones(ProjectName project) Retrieves the list of Zone resources available to the specified project.
ZoneClient.ListZonesPagedResponse	listZones(String project) Retrieves the list of Zone resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListZonesHttpRequest,ZoneList>	listZonesCallable() Retrieves the list of Zone resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListZonesHttpRequest,ZoneClient.ListZonesPagedResponse>	listZonesPagedCallable() Retrieves the list of Zone 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

ZoneClient

protected ZoneClient(ZoneSettings settings)
              throws IOException

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

ZoneClient

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

Method Detail

create

public static final ZoneClient create()
                               throws IOException

Constructs an instance of ZoneClient with default settings.

Throws:

IOException

create

public static final ZoneClient create(ZoneSettings settings)
                               throws IOException

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

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

getSettings

public final ZoneSettings getSettings()

getStub

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

getZone

@BetaApi
public final Zone getZone(ProjectZoneName zone)

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Zone response = zoneClient.getZone(zone);
 }
 

Parameters:

zone - Name of the zone resource to return.

Throws:

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

getZone

@BetaApi
public final Zone getZone(String zone)

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Zone response = zoneClient.getZone(zone.toString());
 }
 

Parameters:

zone - Name of the zone resource to return.

Throws:

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

getZone

@BetaApi
public final Zone getZone(GetZoneHttpRequest request)

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   GetZoneHttpRequest request = GetZoneHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   Zone response = zoneClient.getZone(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

getZoneCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetZoneHttpRequest,Zone> getZoneCallable()

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   GetZoneHttpRequest request = GetZoneHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   ApiFuture<Zone> future = zoneClient.getZoneCallable().futureCall(request);
   // Do something
   Zone response = future.get();
 }
 

listZones

@BetaApi
public final ZoneClient.ListZonesPagedResponse listZones(ProjectName project)

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

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Zone element : zoneClient.listZones(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listZones

@BetaApi
public final ZoneClient.ListZonesPagedResponse listZones(String project)

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

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Zone element : zoneClient.listZones(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listZones

@BetaApi
public final ZoneClient.ListZonesPagedResponse listZones(ListZonesHttpRequest request)

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

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListZonesHttpRequest request = ListZonesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Zone element : zoneClient.listZones(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

listZonesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListZonesHttpRequest,ZoneClient.ListZonesPagedResponse> listZonesPagedCallable()

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

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListZonesHttpRequest request = ListZonesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListZonesPagedResponse> future = zoneClient.listZonesPagedCallable().futureCall(request);
   // Do something
   for (Zone element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listZonesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListZonesHttpRequest,ZoneList> listZonesCallable()

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

Sample code:

 try (ZoneClient zoneClient = ZoneClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListZonesHttpRequest request = ListZonesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     ZoneList response = zoneClient.listZonesCallable().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