Class RegionInstanceGroupsClient (1.7.2)

Version 1.7.2

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 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 RegionInstanceGroupsClient implements BackgroundResource

Service Description: The RegionInstanceGroups 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:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   InstanceGroup response = regionInstanceGroupsClient.get(project, region, instanceGroup);
 }
 

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

To customize credentials:

 RegionInstanceGroupsSettings regionInstanceGroupsSettings =
     RegionInstanceGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create(regionInstanceGroupsSettings);
 

To customize the endpoint:

 RegionInstanceGroupsSettings regionInstanceGroupsSettings =
     RegionInstanceGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create(regionInstanceGroupsSettings);
 

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

Inheritance

java.lang.Object > RegionInstanceGroupsClient

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

Constructs an instance of RegionInstanceGroupsClient with default settings.

Returns

Type	Description
RegionInstanceGroupsClient

Exceptions

Type	Description
IOException

create(RegionInstanceGroupsSettings settings)

public static final RegionInstanceGroupsClient create(RegionInstanceGroupsSettings settings)

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

Returns

Type	Description
RegionInstanceGroupsClient

Exceptions

Type	Description
IOException

create(RegionInstanceGroupsStub stub)

public static final RegionInstanceGroupsClient create(RegionInstanceGroupsStub stub)

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

Parameter

Name	Description
stub	RegionInstanceGroupsStub

Returns

Type	Description
RegionInstanceGroupsClient

Constructors

RegionInstanceGroupsClient(RegionInstanceGroupsSettings settings)

protected RegionInstanceGroupsClient(RegionInstanceGroupsSettings settings)

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

RegionInstanceGroupsClient(RegionInstanceGroupsStub stub)

protected RegionInstanceGroupsClient(RegionInstanceGroupsStub stub)

Parameter

Name	Description
stub	RegionInstanceGroupsStub

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

get(GetRegionInstanceGroupRequest request)

public final InstanceGroup get(GetRegionInstanceGroupRequest request)

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   GetRegionInstanceGroupRequest request =
       GetRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   InstanceGroup response = regionInstanceGroupsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
InstanceGroup

get(String project, String region, String instanceGroup)

public final InstanceGroup get(String project, String region, String instanceGroup)

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   InstanceGroup response = regionInstanceGroupsClient.get(project, region, instanceGroup);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
instanceGroup	String Name of the instance group resource to return.

Returns

Type	Description
InstanceGroup

getCallable()

public final UnaryCallable<GetRegionInstanceGroupRequest,InstanceGroup> getCallable()

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   GetRegionInstanceGroupRequest request =
       GetRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetRegionInstanceGroupRequest,InstanceGroup>

getSettings()

public final RegionInstanceGroupsSettings getSettings()

Returns

Type	Description
RegionInstanceGroupsSettings

getStub()

public RegionInstanceGroupsStub getStub()

Returns

Type	Description
RegionInstanceGroupsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListRegionInstanceGroupsRequest request)

public final RegionInstanceGroupsClient.ListPagedResponse list(ListRegionInstanceGroupsRequest request)

Retrieves the list of instance group resources contained within the specified region.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListRegionInstanceGroupsRequest request =
       ListRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (InstanceGroup element : regionInstanceGroupsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
RegionInstanceGroupsClient.ListPagedResponse

list(String project, String region)

public final RegionInstanceGroupsClient.ListPagedResponse list(String project, String region)

Retrieves the list of instance group resources contained within the specified region.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (InstanceGroup element : regionInstanceGroupsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

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

Returns

Type	Description
RegionInstanceGroupsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupList> listCallable()

Retrieves the list of instance group resources contained within the specified region.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListRegionInstanceGroupsRequest request =
       ListRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RegionInstanceGroupList response = regionInstanceGroupsClient.listCallable().call(request);
     for (InstanceGroup element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupList>

listInstances(ListInstancesRegionInstanceGroupsRequest request)

public final RegionInstanceGroupsClient.ListInstancesPagedResponse listInstances(ListInstancesRegionInstanceGroupsRequest request)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListInstancesRegionInstanceGroupsRequest request =
       ListInstancesRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroup("instanceGroup-1404696854")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsListInstancesRequestResource(
               RegionInstanceGroupsListInstancesRequest.newBuilder().build())
           .setReturnPartialSuccess(true)
           .build();
   for (InstanceWithNamedPorts element :
       regionInstanceGroupsClient.listInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
RegionInstanceGroupsClient.ListInstancesPagedResponse

listInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource)

public final RegionInstanceGroupsClient.ListInstancesPagedResponse listInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource =
       RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   for (InstanceWithNamedPorts element :
       regionInstanceGroupsClient
           .listInstances(
               project, region, instanceGroup, regionInstanceGroupsListInstancesRequestResource)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
instanceGroup	String Name of the regional instance group for which we want to list the instances.
regionInstanceGroupsListInstancesRequestResource	RegionInstanceGroupsListInstancesRequest The body resource for this request

Returns

Type	Description
RegionInstanceGroupsClient.ListInstancesPagedResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsListInstances> listInstancesCallable()

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListInstancesRegionInstanceGroupsRequest request =
       ListInstancesRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroup("instanceGroup-1404696854")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsListInstancesRequestResource(
               RegionInstanceGroupsListInstancesRequest.newBuilder().build())
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RegionInstanceGroupsListInstances response =
         regionInstanceGroupsClient.listInstancesCallable().call(request);
     for (InstanceWithNamedPorts element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsListInstances>

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListInstancesRegionInstanceGroupsRequest request =
       ListInstancesRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroup("instanceGroup-1404696854")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsListInstancesRequestResource(
               RegionInstanceGroupsListInstancesRequest.newBuilder().build())
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListInstancesRegionInstanceGroupsRequest,ListInstancesPagedResponse>

listPagedCallable()

public final UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of instance group resources contained within the specified region.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListRegionInstanceGroupsRequest request =
       ListRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListRegionInstanceGroupsRequest,ListPagedResponse>

setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request)

public final OperationFuture<Operation,Operation> setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request)

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   SetNamedPortsRegionInstanceGroupRequest request =
       SetNamedPortsRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsSetNamedPortsRequestResource(
               RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionInstanceGroupsClient.setNamedPortsAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

public final OperationFuture<Operation,Operation> setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource =
       RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build();
   Operation response =
       regionInstanceGroupsClient
           .setNamedPortsAsync(
               project, region, instanceGroup, regionInstanceGroupsSetNamedPortsRequestResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
instanceGroup	String The name of the regional instance group where the named ports are updated.
regionInstanceGroupsSetNamedPortsRequestResource	RegionInstanceGroupsSetNamedPortsRequest The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setNamedPortsCallable()

public final UnaryCallable<SetNamedPortsRegionInstanceGroupRequest,Operation> setNamedPortsCallable()

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   SetNamedPortsRegionInstanceGroupRequest request =
       SetNamedPortsRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsSetNamedPortsRequestResource(
               RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionInstanceGroupsClient.setNamedPortsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<SetNamedPortsRegionInstanceGroupRequest,Operation>

setNamedPortsOperationCallable()

public final OperationCallable<SetNamedPortsRegionInstanceGroupRequest,Operation,Operation> setNamedPortsOperationCallable()

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   SetNamedPortsRegionInstanceGroupRequest request =
       SetNamedPortsRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsSetNamedPortsRequestResource(
               RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<SetNamedPortsRegionInstanceGroupRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()