Class ZoneOperationsClient (1.14.0)

Version 1.14.0

• 1.52.0 (latest)
• 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 ZoneOperationsClient implements BackgroundResource

Service Description: The ZoneOperations 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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String operation = "operation1662702951";
   DeleteZoneOperationResponse response = zoneOperationsClient.delete(project, zone, operation);
 }
 

Note: close() needs to be called on the ZoneOperationsClient 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 ZoneOperationsSettings 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
 ZoneOperationsSettings zoneOperationsSettings =
     ZoneOperationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create(zoneOperationsSettings);
 

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
 ZoneOperationsSettings zoneOperationsSettings =
     ZoneOperationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create(zoneOperationsSettings);
 

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

Inheritance

java.lang.Object > ZoneOperationsClient

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 ZoneOperationsClient create()

Constructs an instance of ZoneOperationsClient with default settings.

Returns

Type	Description
ZoneOperationsClient

Exceptions

Type	Description
IOException

create(ZoneOperationsSettings settings)

public static final ZoneOperationsClient create(ZoneOperationsSettings settings)

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

Returns

Type	Description
ZoneOperationsClient

Exceptions

Type	Description
IOException

create(ZoneOperationsStub stub)

public static final ZoneOperationsClient create(ZoneOperationsStub stub)

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

Parameter

Name	Description
stub	ZoneOperationsStub

Returns

Type	Description
ZoneOperationsClient

Constructors

ZoneOperationsClient(ZoneOperationsSettings settings)

protected ZoneOperationsClient(ZoneOperationsSettings settings)

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

ZoneOperationsClient(ZoneOperationsStub stub)

protected ZoneOperationsClient(ZoneOperationsStub stub)

Parameter

Name	Description
stub	ZoneOperationsStub

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()

delete(DeleteZoneOperationRequest request)

public final DeleteZoneOperationResponse delete(DeleteZoneOperationRequest request)

Deletes the specified zone-specific Operations resource.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   DeleteZoneOperationRequest request =
       DeleteZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   DeleteZoneOperationResponse response = zoneOperationsClient.delete(request);
 }
 

Parameter

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

Returns

Type	Description
DeleteZoneOperationResponse

delete(String project, String zone, String operation)

public final DeleteZoneOperationResponse delete(String project, String zone, String operation)

Deletes the specified zone-specific Operations resource.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String operation = "operation1662702951";
   DeleteZoneOperationResponse response = zoneOperationsClient.delete(project, zone, operation);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String Name of the zone for this request.
operation	String Name of the Operations resource to delete.

Returns

Type	Description
DeleteZoneOperationResponse

deleteCallable()

public final UnaryCallable<DeleteZoneOperationRequest,DeleteZoneOperationResponse> deleteCallable()

Deletes the specified zone-specific Operations resource.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   DeleteZoneOperationRequest request =
       DeleteZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<DeleteZoneOperationResponse> future =
       zoneOperationsClient.deleteCallable().futureCall(request);
   // Do something.
   DeleteZoneOperationResponse response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteZoneOperationRequest,DeleteZoneOperationResponse>

get(GetZoneOperationRequest request)

public final Operation get(GetZoneOperationRequest request)

Retrieves the specified zone-specific Operations resource.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   GetZoneOperationRequest request =
       GetZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Operation response = zoneOperationsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
Operation

get(String project, String zone, String operation)

public final Operation get(String project, String zone, String operation)

Retrieves the specified zone-specific Operations resource.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String operation = "operation1662702951";
   Operation response = zoneOperationsClient.get(project, zone, operation);
 }
 

Parameters

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

Returns

Type	Description
Operation

getCallable()

public final UnaryCallable<GetZoneOperationRequest,Operation> getCallable()

Retrieves the specified zone-specific Operations resource.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   GetZoneOperationRequest request =
       GetZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = zoneOperationsClient.getCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetZoneOperationRequest,Operation>

getSettings()

public final ZoneOperationsSettings getSettings()

Returns

Type	Description
ZoneOperationsSettings

getStub()

public ZoneOperationsStub getStub()

Returns

Type	Description
ZoneOperationsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListZoneOperationsRequest request)

public final ZoneOperationsClient.ListPagedResponse list(ListZoneOperationsRequest request)

Retrieves a list of Operation resources contained within the specified zone.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   ListZoneOperationsRequest request =
       ListZoneOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (Operation element : zoneOperationsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
ZoneOperationsClient.ListPagedResponse

list(String project, String zone)

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

Retrieves a list of Operation resources contained within the specified zone.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (Operation element : zoneOperationsClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

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

Returns

Type	Description
ZoneOperationsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListZoneOperationsRequest,OperationList> listCallable()

Retrieves a list of Operation resources contained within the specified zone.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   ListZoneOperationsRequest request =
       ListZoneOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     OperationList response = zoneOperationsClient.listCallable().call(request);
     for (Operation element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListZoneOperationsRequest,OperationList>

listPagedCallable()

public final UnaryCallable<ListZoneOperationsRequest,ZoneOperationsClient.ListPagedResponse> listPagedCallable()

Retrieves a list of Operation resources contained within the specified zone.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   ListZoneOperationsRequest request =
       ListZoneOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = zoneOperationsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Operation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListZoneOperationsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

wait(WaitZoneOperationRequest request)

public final Operation wait(WaitZoneOperationRequest request)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   WaitZoneOperationRequest request =
       WaitZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Operation response = zoneOperationsClient.wait(request);
 }
 

Parameter

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

Returns

Type	Description
Operation

wait(String project, String zone, String operation)

public final Operation wait(String project, String zone, String operation)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String operation = "operation1662702951";
   Operation response = zoneOperationsClient.wait(project, zone, operation);
 }
 

Parameters

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

Returns

Type	Description
Operation

waitCallable()

public final UnaryCallable<WaitZoneOperationRequest,Operation> waitCallable()

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   WaitZoneOperationRequest request =
       WaitZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = zoneOperationsClient.waitCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<WaitZoneOperationRequest,Operation>