com.google.cloud.compute.v1

Class RegionInstanceGroupsClient

java.lang.Object

com.google.cloud.compute.v1.RegionInstanceGroupsClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator-java")
public class RegionInstanceGroupsClient
extends Object
implements com.google.api.gax.core.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:

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

Methods

Method	Description	Method Variants
Get	Returns the specified instance group resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRegionInstanceGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String instanceGroup) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
List	Retrieves the list of instance group resources contained within the specified region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRegionInstanceGroupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
ListInstances	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listInstances(ListInstancesRegionInstanceGroupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listInstancesPagedCallable() listInstancesCallable()
SetNamedPorts	Sets the named ports for the specified regional instance group.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setNamedPortsOperationCallable() setNamedPortsCallable()

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:

 // 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
 RegionInstanceGroupsSettings regionInstanceGroupsSettings =
     RegionInstanceGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create(regionInstanceGroupsSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionInstanceGroupsClient.ListFixedSizeCollection
static class	RegionInstanceGroupsClient.ListInstancesFixedSizeCollection
static class	RegionInstanceGroupsClient.ListInstancesPage
static class	RegionInstanceGroupsClient.ListInstancesPagedResponse
static class	RegionInstanceGroupsClient.ListPage
static class	RegionInstanceGroupsClient.ListPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionInstanceGroupsClient(RegionInstanceGroupsSettings settings) Constructs an instance of RegionInstanceGroupsClient, using the given settings.
protected	RegionInstanceGroupsClient(RegionInstanceGroupsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionInstanceGroupsClient	create() Constructs an instance of RegionInstanceGroupsClient with default settings.
static RegionInstanceGroupsClient	create(RegionInstanceGroupsSettings settings) Constructs an instance of RegionInstanceGroupsClient, using the given settings.
static RegionInstanceGroupsClient	create(RegionInstanceGroupsStub stub) Constructs an instance of RegionInstanceGroupsClient, using the given stub for making calls.
InstanceGroup	get(GetRegionInstanceGroupRequest request) Returns the specified instance group resource.
InstanceGroup	get(String project, String region, String instanceGroup) Returns the specified instance group resource.
com.google.api.gax.rpc.UnaryCallable<GetRegionInstanceGroupRequest,InstanceGroup>	getCallable() Returns the specified instance group resource.
RegionInstanceGroupsSettings	getSettings()
RegionInstanceGroupsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RegionInstanceGroupsClient.ListPagedResponse	list(ListRegionInstanceGroupsRequest request) Retrieves the list of instance group resources contained within the specified region.
RegionInstanceGroupsClient.ListPagedResponse	list(String project, String region) Retrieves the list of instance group resources contained within the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupList>	listCallable() Retrieves the list of instance group resources contained within the specified region.
RegionInstanceGroupsClient.ListInstancesPagedResponse	listInstances(ListInstancesRegionInstanceGroupsRequest request) Lists the instances in the specified instance group and displays information about the named ports.
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.
com.google.api.gax.rpc.UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsListInstances>	listInstancesCallable() Lists the instances in the specified instance group and displays information about the named ports.
com.google.api.gax.rpc.UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListInstancesPagedResponse>	listInstancesPagedCallable() Lists the instances in the specified instance group and displays information about the named ports.
com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListPagedResponse>	listPagedCallable() Retrieves the list of instance group resources contained within the specified region.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request) Sets the named ports for the specified regional instance group.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource) Sets the named ports for the specified regional instance group.
com.google.api.gax.rpc.UnaryCallable<SetNamedPortsRegionInstanceGroupRequest,Operation>	setNamedPortsCallable() Sets the named ports for the specified regional instance group.
com.google.api.gax.rpc.OperationCallable<SetNamedPortsRegionInstanceGroupRequest,Operation,Operation>	setNamedPortsOperationCallable() Sets the named ports for the specified regional instance group.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionInstanceGroupsClient

protected RegionInstanceGroupsClient(RegionInstanceGroupsSettings settings)
                              throws IOException

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.

Throws:

IOException

RegionInstanceGroupsClient

protected RegionInstanceGroupsClient(RegionInstanceGroupsStub stub)

Method Detail

create

public static final RegionInstanceGroupsClient create()
                                               throws IOException

Constructs an instance of RegionInstanceGroupsClient with default settings.

Throws:

IOException

create

public static final RegionInstanceGroupsClient create(RegionInstanceGroupsSettings settings)
                                               throws IOException

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.

Throws:

IOException

create

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

getSettings

public final RegionInstanceGroupsSettings getSettings()

getStub

public RegionInstanceGroupsStub getStub()

get

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

Returns the specified instance group resource.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   InstanceGroup response = regionInstanceGroupsClient.get(project, region, instanceGroup);
 }
 

Parameters:

project - Project ID for this request.

region - Name of the region scoping this request.

instanceGroup - Name of the instance group resource to return.

Throws:

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

get

public final InstanceGroup get(GetRegionInstanceGroupRequest request)

Returns the specified instance group resource.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   GetRegionInstanceGroupRequest request =
       GetRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   InstanceGroup response = regionInstanceGroupsClient.get(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

getCallable

public final com.google.api.gax.rpc.UnaryCallable<GetRegionInstanceGroupRequest,InstanceGroup> getCallable()

Returns the specified instance group resource.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   GetRegionInstanceGroupRequest request =
       GetRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<InstanceGroup> future =
       regionInstanceGroupsClient.getCallable().futureCall(request);
   // Do something.
   InstanceGroup response = future.get();
 }
 

list

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

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

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (InstanceGroup element : regionInstanceGroupsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

region - Name of the region scoping this request.

Throws:

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

list

public final RegionInstanceGroupsClient.ListPagedResponse list(ListRegionInstanceGroupsRequest request)

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

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

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

listPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListPagedResponse> listPagedCallable()

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

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 (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<InstanceGroup> future =
       regionInstanceGroupsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InstanceGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupList> listCallable()

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

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 (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.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listInstances

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:

 // 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 (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:

project - Project ID for this request.

region - Name of the region scoping this request.

instanceGroup - Name of the regional instance group for which we want to list the instances.

regionInstanceGroupsListInstancesRequestResource - The body resource for this request

Throws:

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

listInstances

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:

 // 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 (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);
   }
 }
 

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

listInstancesPagedCallable

public final com.google.api.gax.rpc.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:

 // 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 (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<InstanceWithNamedPorts> future =
       regionInstanceGroupsClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (InstanceWithNamedPorts element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listInstancesCallable

public final com.google.api.gax.rpc.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:

 // 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 (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.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

setNamedPortsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setNamedPortsAsync(String project,
                                                                                                    String region,
                                                                                                    String instanceGroup,
                                                                                                    RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

Sets the named ports for the specified regional instance group.

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

project - Project ID for this request.

region - Name of the region scoping this request.

instanceGroup - The name of the regional instance group where the named ports are updated.

regionInstanceGroupsSetNamedPortsRequestResource - The body resource for this request

Throws:

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

setNamedPortsAsync

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

Sets the named ports for the specified regional instance group.

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

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

setNamedPortsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SetNamedPortsRegionInstanceGroupRequest,Operation,Operation> setNamedPortsOperationCallable()

Sets the named ports for the specified regional instance group.

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 (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<Operation, Operation> future =
       regionInstanceGroupsClient.setNamedPortsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

setNamedPortsCallable

public final com.google.api.gax.rpc.UnaryCallable<SetNamedPortsRegionInstanceGroupRequest,Operation> setNamedPortsCallable()

Sets the named ports for the specified regional instance group.

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

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