com.google.cloud.compute.v1

Class RegionOperationClient

java.lang.Object

com.google.cloud.compute.v1.RegionOperationClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class RegionOperationClient
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 (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionOperationName operation = ProjectRegionOperationName.of("[PROJECT]", "[REGION]", "[OPERATION]");
   regionOperationClient.deleteRegionOperation(operation);
 }
 
 

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

To customize credentials:

 
 RegionOperationSettings regionOperationSettings =
     RegionOperationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionOperationClient regionOperationClient =
     RegionOperationClient.create(regionOperationSettings);
 
 

To customize the endpoint:

 
 RegionOperationSettings regionOperationSettings =
     RegionOperationSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionOperationClient regionOperationClient =
     RegionOperationClient.create(regionOperationSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionOperationClient.ListRegionOperationsFixedSizeCollection
static class	RegionOperationClient.ListRegionOperationsPage
static class	RegionOperationClient.ListRegionOperationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionOperationClient(RegionOperationSettings settings) Constructs an instance of RegionOperationClient, using the given settings.
protected	RegionOperationClient(RegionOperationStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionOperationClient	create() Constructs an instance of RegionOperationClient with default settings.
static RegionOperationClient	create(RegionOperationSettings settings) Constructs an instance of RegionOperationClient, using the given settings.
static RegionOperationClient	create(RegionOperationStub stub) Constructs an instance of RegionOperationClient, using the given stub for making calls.
void	deleteRegionOperation(DeleteRegionOperationHttpRequest request) Deletes the specified region-specific Operations resource.
void	deleteRegionOperation(ProjectRegionOperationName operation) Deletes the specified region-specific Operations resource.
void	deleteRegionOperation(String operation) Deletes the specified region-specific Operations resource.
com.google.api.gax.rpc.UnaryCallable<DeleteRegionOperationHttpRequest,Void>	deleteRegionOperationCallable() Deletes the specified region-specific Operations resource.
Operation	getRegionOperation(GetRegionOperationHttpRequest request) Retrieves the specified region-specific Operations resource.
Operation	getRegionOperation(ProjectRegionOperationName operation) Retrieves the specified region-specific Operations resource.
Operation	getRegionOperation(String operation) Retrieves the specified region-specific Operations resource.
com.google.api.gax.rpc.UnaryCallable<GetRegionOperationHttpRequest,Operation>	getRegionOperationCallable() Retrieves the specified region-specific Operations resource.
RegionOperationSettings	getSettings()
RegionOperationStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RegionOperationClient.ListRegionOperationsPagedResponse	listRegionOperations(ListRegionOperationsHttpRequest request) Retrieves a list of Operation resources contained within the specified region.
RegionOperationClient.ListRegionOperationsPagedResponse	listRegionOperations(ProjectRegionName region) Retrieves a list of Operation resources contained within the specified region.
RegionOperationClient.ListRegionOperationsPagedResponse	listRegionOperations(String region) Retrieves a list of Operation resources contained within the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionOperationsHttpRequest,OperationList>	listRegionOperationsCallable() Retrieves a list of Operation resources contained within the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionOperationsHttpRequest,RegionOperationClient.ListRegionOperationsPagedResponse>	listRegionOperationsPagedCallable() Retrieves a list of Operation resources contained within the specified region.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionOperationClient

protected RegionOperationClient(RegionOperationSettings settings)
                         throws IOException

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

RegionOperationClient

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

Method Detail

create

public static final RegionOperationClient create()
                                          throws IOException

Constructs an instance of RegionOperationClient with default settings.

Throws:

IOException

create

public static final RegionOperationClient create(RegionOperationSettings settings)
                                          throws IOException

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

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

getSettings

public final RegionOperationSettings getSettings()

getStub

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

deleteRegionOperation

@BetaApi
public final void deleteRegionOperation(ProjectRegionOperationName operation)

Deletes the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionOperationName operation = ProjectRegionOperationName.of("[PROJECT]", "[REGION]", "[OPERATION]");
   regionOperationClient.deleteRegionOperation(operation);
 }
 

Parameters:

operation - Name of the Operations resource to delete.

Throws:

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

deleteRegionOperation

@BetaApi
public final void deleteRegionOperation(String operation)

Deletes the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionOperationName operation = ProjectRegionOperationName.of("[PROJECT]", "[REGION]", "[OPERATION]");
   regionOperationClient.deleteRegionOperation(operation.toString());
 }
 

Parameters:

operation - Name of the Operations resource to delete.

Throws:

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

deleteRegionOperation

@BetaApi
public final void deleteRegionOperation(DeleteRegionOperationHttpRequest request)

Deletes the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedOperation = ProjectRegionOperationName.format("[PROJECT]", "[REGION]", "[OPERATION]");
   DeleteRegionOperationHttpRequest request = DeleteRegionOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   regionOperationClient.deleteRegionOperation(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

deleteRegionOperationCallable

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

Deletes the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedOperation = ProjectRegionOperationName.format("[PROJECT]", "[REGION]", "[OPERATION]");
   DeleteRegionOperationHttpRequest request = DeleteRegionOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   ApiFuture<Void> future = regionOperationClient.deleteRegionOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

getRegionOperation

@BetaApi
public final Operation getRegionOperation(ProjectRegionOperationName operation)

Retrieves the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionOperationName operation = ProjectRegionOperationName.of("[PROJECT]", "[REGION]", "[OPERATION]");
   Operation response = regionOperationClient.getRegionOperation(operation);
 }
 

Parameters:

operation - Name of the Operations resource to return.

Throws:

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

getRegionOperation

@BetaApi
public final Operation getRegionOperation(String operation)

Retrieves the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionOperationName operation = ProjectRegionOperationName.of("[PROJECT]", "[REGION]", "[OPERATION]");
   Operation response = regionOperationClient.getRegionOperation(operation.toString());
 }
 

Parameters:

operation - Name of the Operations resource to return.

Throws:

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

getRegionOperation

@BetaApi
public final Operation getRegionOperation(GetRegionOperationHttpRequest request)

Retrieves the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedOperation = ProjectRegionOperationName.format("[PROJECT]", "[REGION]", "[OPERATION]");
   GetRegionOperationHttpRequest request = GetRegionOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   Operation response = regionOperationClient.getRegionOperation(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

getRegionOperationCallable

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

Retrieves the specified region-specific Operations resource.

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedOperation = ProjectRegionOperationName.format("[PROJECT]", "[REGION]", "[OPERATION]");
   GetRegionOperationHttpRequest request = GetRegionOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   ApiFuture<Operation> future = regionOperationClient.getRegionOperationCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listRegionOperations

@BetaApi
public final RegionOperationClient.ListRegionOperationsPagedResponse listRegionOperations(ProjectRegionName region)

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

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (Operation element : regionOperationClient.listRegionOperations(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region for this request.

Throws:

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

listRegionOperations

@BetaApi
public final RegionOperationClient.ListRegionOperationsPagedResponse listRegionOperations(String region)

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

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (Operation element : regionOperationClient.listRegionOperations(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region for this request.

Throws:

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

listRegionOperations

@BetaApi
public final RegionOperationClient.ListRegionOperationsPagedResponse listRegionOperations(ListRegionOperationsHttpRequest request)

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

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionOperationsHttpRequest request = ListRegionOperationsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (Operation element : regionOperationClient.listRegionOperations(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

listRegionOperationsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionOperationsHttpRequest,RegionOperationClient.ListRegionOperationsPagedResponse> listRegionOperationsPagedCallable()

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

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionOperationsHttpRequest request = ListRegionOperationsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListRegionOperationsPagedResponse> future = regionOperationClient.listRegionOperationsPagedCallable().futureCall(request);
   // Do something
   for (Operation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionOperationsCallable

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

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

Sample code:

 try (RegionOperationClient regionOperationClient = RegionOperationClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionOperationsHttpRequest request = ListRegionOperationsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     OperationList response = regionOperationClient.listRegionOperationsCallable().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