Class RegionInstancesClient (1.56.0)

GitHub RepositoryProduct Reference

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.

Inheritance

java.lang.Object > RegionInstancesClient

Static Methods

create()

public static final RegionInstancesClient create()

Constructs an instance of RegionInstancesClient with default settings.

Returns
Type Description
RegionInstancesClient
Exceptions
Type Description
IOException

create(RegionInstancesSettings settings)

public static final RegionInstancesClient create(RegionInstancesSettings settings)

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.

Parameter
Name Description
settings RegionInstancesSettings
Returns
Type Description
RegionInstancesClient
Exceptions
Type Description
IOException

create(RegionInstancesStub stub)

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

Parameter
Name Description
stub RegionInstancesStub
Returns
Type Description
RegionInstancesClient

Constructors

RegionInstancesClient(RegionInstancesSettings settings)

protected RegionInstancesClient(RegionInstancesSettings settings)

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.

Parameter
Name Description
settings RegionInstancesSettings

RegionInstancesClient(RegionInstancesStub stub)

protected RegionInstancesClient(RegionInstancesStub stub)
Parameter
Name Description
stub RegionInstancesStub

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

bulkInsertAsync(BulkInsertRegionInstanceRequest request)

public final 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();
 }
Parameter
Name Description
request BulkInsertRegionInstanceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

bulkInsertAsync(String project, String region, BulkInsertInstanceResource bulkInsertInstanceResourceResource)

public final 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
Name Description
project String

Project ID for this request.
region String

The name of the region for this request.
bulkInsertInstanceResourceResource BulkInsertInstanceResource

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

bulkInsertCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<BulkInsertRegionInstanceRequest,Operation>

bulkInsertOperationCallable()

public final 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();
 }
Returns
Type Description
OperationCallable<BulkInsertRegionInstanceRequest,Operation,Operation>

close()

public final void close()

getSettings()

public final RegionInstancesSettings getSettings()
Returns
Type Description
RegionInstancesSettings

getStub()

public RegionInstancesStub getStub()
Returns
Type Description
RegionInstancesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()