com.google.cloud.compute.v1

Class ZoneOperationClient

java.lang.Object

com.google.cloud.compute.v1.ZoneOperationClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class ZoneOperationClient
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 (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneOperationName operation = ProjectZoneOperationName.of("[PROJECT]", "[ZONE]", "[OPERATION]");
   zoneOperationClient.deleteZoneOperation(operation);
 }
 
 

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

To customize credentials:

 
 ZoneOperationSettings zoneOperationSettings =
     ZoneOperationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ZoneOperationClient zoneOperationClient =
     ZoneOperationClient.create(zoneOperationSettings);
 
 

To customize the endpoint:

 
 ZoneOperationSettings zoneOperationSettings =
     ZoneOperationSettings.newBuilder().setEndpoint(myEndpoint).build();
 ZoneOperationClient zoneOperationClient =
     ZoneOperationClient.create(zoneOperationSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZoneOperationClient.ListZoneOperationsFixedSizeCollection
static class	ZoneOperationClient.ListZoneOperationsPage
static class	ZoneOperationClient.ListZoneOperationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ZoneOperationClient(ZoneOperationSettings settings) Constructs an instance of ZoneOperationClient, using the given settings.
protected	ZoneOperationClient(ZoneOperationStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ZoneOperationClient	create() Constructs an instance of ZoneOperationClient with default settings.
static ZoneOperationClient	create(ZoneOperationSettings settings) Constructs an instance of ZoneOperationClient, using the given settings.
static ZoneOperationClient	create(ZoneOperationStub stub) Constructs an instance of ZoneOperationClient, using the given stub for making calls.
void	deleteZoneOperation(DeleteZoneOperationHttpRequest request) Deletes the specified zone-specific Operations resource.
void	deleteZoneOperation(ProjectZoneOperationName operation) Deletes the specified zone-specific Operations resource.
void	deleteZoneOperation(String operation) Deletes the specified zone-specific Operations resource.
com.google.api.gax.rpc.UnaryCallable<DeleteZoneOperationHttpRequest,Void>	deleteZoneOperationCallable() Deletes the specified zone-specific Operations resource.
ZoneOperationSettings	getSettings()
ZoneOperationStub	getStub()
Operation	getZoneOperation(GetZoneOperationHttpRequest request) Retrieves the specified zone-specific Operations resource.
Operation	getZoneOperation(ProjectZoneOperationName operation) Retrieves the specified zone-specific Operations resource.
Operation	getZoneOperation(String operation) Retrieves the specified zone-specific Operations resource.
com.google.api.gax.rpc.UnaryCallable<GetZoneOperationHttpRequest,Operation>	getZoneOperationCallable() Retrieves the specified zone-specific Operations resource.
boolean	isShutdown()
boolean	isTerminated()
ZoneOperationClient.ListZoneOperationsPagedResponse	listZoneOperations(ListZoneOperationsHttpRequest request) Retrieves a list of Operation resources contained within the specified zone.
ZoneOperationClient.ListZoneOperationsPagedResponse	listZoneOperations(ProjectZoneName zone) Retrieves a list of Operation resources contained within the specified zone.
ZoneOperationClient.ListZoneOperationsPagedResponse	listZoneOperations(String zone) Retrieves a list of Operation resources contained within the specified zone.
com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsHttpRequest,OperationList>	listZoneOperationsCallable() Retrieves a list of Operation resources contained within the specified zone.
com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsHttpRequest,ZoneOperationClient.ListZoneOperationsPagedResponse>	listZoneOperationsPagedCallable() Retrieves a list of Operation resources contained within the specified zone.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZoneOperationClient

protected ZoneOperationClient(ZoneOperationSettings settings)
                       throws IOException

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

ZoneOperationClient

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

Method Detail

create

public static final ZoneOperationClient create()
                                        throws IOException

Constructs an instance of ZoneOperationClient with default settings.

Throws:

IOException

create

public static final ZoneOperationClient create(ZoneOperationSettings settings)
                                        throws IOException

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

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

getSettings

public final ZoneOperationSettings getSettings()

getStub

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

deleteZoneOperation

@BetaApi
public final void deleteZoneOperation(ProjectZoneOperationName operation)

Deletes the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneOperationName operation = ProjectZoneOperationName.of("[PROJECT]", "[ZONE]", "[OPERATION]");
   zoneOperationClient.deleteZoneOperation(operation);
 }
 

Parameters:

operation - Name of the Operations resource to delete.

Throws:

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

deleteZoneOperation

@BetaApi
public final void deleteZoneOperation(String operation)

Deletes the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneOperationName operation = ProjectZoneOperationName.of("[PROJECT]", "[ZONE]", "[OPERATION]");
   zoneOperationClient.deleteZoneOperation(operation.toString());
 }
 

Parameters:

operation - Name of the Operations resource to delete.

Throws:

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

deleteZoneOperation

@BetaApi
public final void deleteZoneOperation(DeleteZoneOperationHttpRequest request)

Deletes the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedOperation = ProjectZoneOperationName.format("[PROJECT]", "[ZONE]", "[OPERATION]");
   DeleteZoneOperationHttpRequest request = DeleteZoneOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   zoneOperationClient.deleteZoneOperation(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

deleteZoneOperationCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteZoneOperationHttpRequest,Void> deleteZoneOperationCallable()

Deletes the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedOperation = ProjectZoneOperationName.format("[PROJECT]", "[ZONE]", "[OPERATION]");
   DeleteZoneOperationHttpRequest request = DeleteZoneOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   ApiFuture<Void> future = zoneOperationClient.deleteZoneOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

getZoneOperation

@BetaApi
public final Operation getZoneOperation(ProjectZoneOperationName operation)

Retrieves the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneOperationName operation = ProjectZoneOperationName.of("[PROJECT]", "[ZONE]", "[OPERATION]");
   Operation response = zoneOperationClient.getZoneOperation(operation);
 }
 

Parameters:

operation - Name of the Operations resource to return.

Throws:

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

getZoneOperation

@BetaApi
public final Operation getZoneOperation(String operation)

Retrieves the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneOperationName operation = ProjectZoneOperationName.of("[PROJECT]", "[ZONE]", "[OPERATION]");
   Operation response = zoneOperationClient.getZoneOperation(operation.toString());
 }
 

Parameters:

operation - Name of the Operations resource to return.

Throws:

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

getZoneOperation

@BetaApi
public final Operation getZoneOperation(GetZoneOperationHttpRequest request)

Retrieves the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedOperation = ProjectZoneOperationName.format("[PROJECT]", "[ZONE]", "[OPERATION]");
   GetZoneOperationHttpRequest request = GetZoneOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   Operation response = zoneOperationClient.getZoneOperation(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

getZoneOperationCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetZoneOperationHttpRequest,Operation> getZoneOperationCallable()

Retrieves the specified zone-specific Operations resource.

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedOperation = ProjectZoneOperationName.format("[PROJECT]", "[ZONE]", "[OPERATION]");
   GetZoneOperationHttpRequest request = GetZoneOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   ApiFuture<Operation> future = zoneOperationClient.getZoneOperationCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listZoneOperations

@BetaApi
public final ZoneOperationClient.ListZoneOperationsPagedResponse listZoneOperations(ProjectZoneName zone)

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

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (Operation element : zoneOperationClient.listZoneOperations(zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

zone - Name of the zone for request.

Throws:

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

listZoneOperations

@BetaApi
public final ZoneOperationClient.ListZoneOperationsPagedResponse listZoneOperations(String zone)

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

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (Operation element : zoneOperationClient.listZoneOperations(zone.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

zone - Name of the zone for request.

Throws:

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

listZoneOperations

@BetaApi
public final ZoneOperationClient.ListZoneOperationsPagedResponse listZoneOperations(ListZoneOperationsHttpRequest request)

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

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListZoneOperationsHttpRequest request = ListZoneOperationsHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   for (Operation element : zoneOperationClient.listZoneOperations(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

listZoneOperationsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsHttpRequest,ZoneOperationClient.ListZoneOperationsPagedResponse> listZoneOperationsPagedCallable()

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

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListZoneOperationsHttpRequest request = ListZoneOperationsHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   ApiFuture<ListZoneOperationsPagedResponse> future = zoneOperationClient.listZoneOperationsPagedCallable().futureCall(request);
   // Do something
   for (Operation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listZoneOperationsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsHttpRequest,OperationList> listZoneOperationsCallable()

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

Sample code:

 try (ZoneOperationClient zoneOperationClient = ZoneOperationClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListZoneOperationsHttpRequest request = ListZoneOperationsHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   while (true) {
     OperationList response = zoneOperationClient.listZoneOperationsCallable().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;
     }
   }
 }
 

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