Class ZonesClient (1.7.2)

Version 1.7.2

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class ZonesClient implements BackgroundResource

Service Description: The Zones 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:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Zone response = zonesClient.get(project, zone);
 }
 

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

To customize credentials:

 ZonesSettings zonesSettings =
     ZonesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ZonesClient zonesClient = ZonesClient.create(zonesSettings);
 

To customize the endpoint:

 ZonesSettings zonesSettings = ZonesSettings.newBuilder().setEndpoint(myEndpoint).build();
 ZonesClient zonesClient = ZonesClient.create(zonesSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ZonesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ZonesClient create()

Constructs an instance of ZonesClient with default settings.

Returns

Type	Description
ZonesClient

Exceptions

Type	Description
IOException

create(ZonesSettings settings)

public static final ZonesClient create(ZonesSettings settings)

Constructs an instance of ZonesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	ZonesSettings

Returns

Type	Description
ZonesClient

Exceptions

Type	Description
IOException

create(ZonesStub stub)

public static final ZonesClient create(ZonesStub stub)

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

Parameter

Name	Description
stub	ZonesStub

Returns

Type	Description
ZonesClient

Constructors

ZonesClient(ZonesSettings settings)

protected ZonesClient(ZonesSettings settings)

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

Parameter

Name	Description
settings	ZonesSettings

ZonesClient(ZonesStub stub)

protected ZonesClient(ZonesStub stub)

Parameter

Name	Description
stub	ZonesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

get(GetZoneRequest request)

public final Zone get(GetZoneRequest request)

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   GetZoneRequest request =
       GetZoneRequest.newBuilder()
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Zone response = zonesClient.get(request);
 }
 

Parameter

Name	Description
request	GetZoneRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Zone

get(String project, String zone)

public final Zone get(String project, String zone)

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Zone response = zonesClient.get(project, zone);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String Name of the zone resource to return.

Returns

Type	Description
Zone

getCallable()

public final UnaryCallable<GetZoneRequest,Zone> getCallable()

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   GetZoneRequest request =
       GetZoneRequest.newBuilder()
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<Zone> future = zonesClient.getCallable().futureCall(request);
   // Do something.
   Zone response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetZoneRequest,Zone>

getSettings()

public final ZonesSettings getSettings()

Returns

Type	Description
ZonesSettings

getStub()

public ZonesStub getStub()

Returns

Type	Description
ZonesStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListZonesRequest request)

public final ZonesClient.ListPagedResponse list(ListZonesRequest request)

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   ListZonesRequest request =
       ListZonesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Zone element : zonesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListZonesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ZonesClient.ListPagedResponse

list(String project)

public final ZonesClient.ListPagedResponse list(String project)

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   String project = "project-309310695";
   for (Zone element : zonesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
ZonesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListZonesRequest,ZoneList> listCallable()

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   ListZonesRequest request =
       ListZonesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ZoneList response = zonesClient.listCallable().call(request);
     for (Zone element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListZonesRequest,ZoneList>

listPagedCallable()

public final UnaryCallable<ListZonesRequest,ZonesClient.ListPagedResponse> listPagedCallable()

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

Sample code:

 try (ZonesClient zonesClient = ZonesClient.create()) {
   ListZonesRequest request =
       ListZonesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Zone> future = zonesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Zone element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListZonesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()