com.google.cloud.compute.v1

Class RegionInstancesClient

java.lang.Object

com.google.cloud.compute.v1.RegionInstancesClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator-java")
public class RegionInstancesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The RegionInstances 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 (RegionInstancesClient regionInstancesClient = RegionInstancesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   BulkInsertInstanceResource bulkInsertInstanceResourceResource =
       BulkInsertInstanceResource.newBuilder().build();
   Operation response =
       regionInstancesClient
           .bulkInsertAsync(project, region, bulkInsertInstanceResourceResource)
           .get();
 }
 

Note: close() needs to be called on the RegionInstancesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
BulkInsert	Creates multiple instances in a given region. Count specifies the number of instances to create.	Request object method variants only take one parameter, a request object, which must be constructed before the call. bulkInsertAsync(BulkInsertRegionInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. bulkInsertAsync(String project, String region, BulkInsertInstanceResource bulkInsertInstanceResourceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. bulkInsertOperationCallable() bulkInsertCallable()

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 RegionInstancesSettings 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
 RegionInstancesSettings regionInstancesSettings =
     RegionInstancesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionInstancesClient regionInstancesClient =
     RegionInstancesClient.create(regionInstancesSettings);
 

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
 RegionInstancesSettings regionInstancesSettings =
     RegionInstancesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionInstancesClient regionInstancesClient =
     RegionInstancesClient.create(regionInstancesSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionInstancesClient(RegionInstancesSettings settings) Constructs an instance of RegionInstancesClient, using the given settings.
protected	RegionInstancesClient(RegionInstancesStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	bulkInsertAsync(BulkInsertRegionInstanceRequest request) Creates multiple instances in a given region.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	bulkInsertAsync(String project, String region, BulkInsertInstanceResource bulkInsertInstanceResourceResource) Creates multiple instances in a given region.
com.google.api.gax.rpc.UnaryCallable<BulkInsertRegionInstanceRequest,Operation>	bulkInsertCallable() Creates multiple instances in a given region.
com.google.api.gax.rpc.OperationCallable<BulkInsertRegionInstanceRequest,Operation,Operation>	bulkInsertOperationCallable() Creates multiple instances in a given region.
void	close()
static RegionInstancesClient	create() Constructs an instance of RegionInstancesClient with default settings.
static RegionInstancesClient	create(RegionInstancesSettings settings) Constructs an instance of RegionInstancesClient, using the given settings.
static RegionInstancesClient	create(RegionInstancesStub stub) Constructs an instance of RegionInstancesClient, using the given stub for making calls.
RegionInstancesSettings	getSettings()
RegionInstancesStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionInstancesClient

protected RegionInstancesClient(RegionInstancesSettings settings)
                         throws IOException

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

RegionInstancesClient

protected RegionInstancesClient(RegionInstancesStub stub)

Method Detail

create

public static final RegionInstancesClient create()
                                          throws IOException

Constructs an instance of RegionInstancesClient with default settings.

Throws:

IOException

create

public static final RegionInstancesClient create(RegionInstancesSettings settings)
                                          throws IOException

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

public static final RegionInstancesClient create(RegionInstancesStub stub)

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

getSettings

public final RegionInstancesSettings getSettings()

getStub

public RegionInstancesStub getStub()

bulkInsertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> bulkInsertAsync(String project,
                                                                                                 String region,
                                                                                                 BulkInsertInstanceResource bulkInsertInstanceResourceResource)

Creates multiple instances in a given region. Count specifies the number of instances to create.

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 (RegionInstancesClient regionInstancesClient = RegionInstancesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   BulkInsertInstanceResource bulkInsertInstanceResourceResource =
       BulkInsertInstanceResource.newBuilder().build();
   Operation response =
       regionInstancesClient
           .bulkInsertAsync(project, region, bulkInsertInstanceResourceResource)
           .get();
 }
 

Parameters:

project - Project ID for this request.

region - The name of the region for this request.

bulkInsertInstanceResourceResource - The body resource for this request

Throws:

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

bulkInsertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> bulkInsertAsync(BulkInsertRegionInstanceRequest request)

Creates multiple instances in a given region. Count specifies the number of instances to create.

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 (RegionInstancesClient regionInstancesClient = RegionInstancesClient.create()) {
   BulkInsertRegionInstanceRequest request =
       BulkInsertRegionInstanceRequest.newBuilder()
           .setBulkInsertInstanceResourceResource(
               BulkInsertInstanceResource.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionInstancesClient.bulkInsertAsync(request).get();
 }
 

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

bulkInsertOperationCallable

public final com.google.api.gax.rpc.OperationCallable<BulkInsertRegionInstanceRequest,Operation,Operation> bulkInsertOperationCallable()

Creates multiple instances in a given region. Count specifies the number of instances to create.

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 (RegionInstancesClient regionInstancesClient = RegionInstancesClient.create()) {
   BulkInsertRegionInstanceRequest request =
       BulkInsertRegionInstanceRequest.newBuilder()
           .setBulkInsertInstanceResourceResource(
               BulkInsertInstanceResource.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionInstancesClient.bulkInsertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

bulkInsertCallable

public final com.google.api.gax.rpc.UnaryCallable<BulkInsertRegionInstanceRequest,Operation> bulkInsertCallable()

Creates multiple instances in a given region. Count specifies the number of instances to create.

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 (RegionInstancesClient regionInstancesClient = RegionInstancesClient.create()) {
   BulkInsertRegionInstanceRequest request =
       BulkInsertRegionInstanceRequest.newBuilder()
           .setBulkInsertInstanceResourceResource(
               BulkInsertInstanceResource.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionInstancesClient.bulkInsertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

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