com.google.cloud.compute.v1

Class RegionInstanceGroupClient

java.lang.Object

com.google.cloud.compute.v1.RegionInstanceGroupClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class RegionInstanceGroupClient
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 (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   InstanceGroup response = regionInstanceGroupClient.getRegionInstanceGroup(instanceGroup);
 }
 
 

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

To customize credentials:

 
 RegionInstanceGroupSettings regionInstanceGroupSettings =
     RegionInstanceGroupSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionInstanceGroupClient regionInstanceGroupClient =
     RegionInstanceGroupClient.create(regionInstanceGroupSettings);
 
 

To customize the endpoint:

 
 RegionInstanceGroupSettings regionInstanceGroupSettings =
     RegionInstanceGroupSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionInstanceGroupClient regionInstanceGroupClient =
     RegionInstanceGroupClient.create(regionInstanceGroupSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsFixedSizeCollection
static class	RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPage
static class	RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse
static class	RegionInstanceGroupClient.ListRegionInstanceGroupsFixedSizeCollection
static class	RegionInstanceGroupClient.ListRegionInstanceGroupsPage
static class	RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionInstanceGroupClient(RegionInstanceGroupSettings settings) Constructs an instance of RegionInstanceGroupClient, using the given settings.
protected	RegionInstanceGroupClient(RegionInstanceGroupStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionInstanceGroupClient	create() Constructs an instance of RegionInstanceGroupClient with default settings.
static RegionInstanceGroupClient	create(RegionInstanceGroupSettings settings) Constructs an instance of RegionInstanceGroupClient, using the given settings.
static RegionInstanceGroupClient	create(RegionInstanceGroupStub stub) Constructs an instance of RegionInstanceGroupClient, using the given stub for making calls.
InstanceGroup	getRegionInstanceGroup(GetRegionInstanceGroupHttpRequest request) Returns the specified instance group resource.
InstanceGroup	getRegionInstanceGroup(ProjectRegionInstanceGroupName instanceGroup) Returns the specified instance group resource.
InstanceGroup	getRegionInstanceGroup(String instanceGroup) Returns the specified instance group resource.
com.google.api.gax.rpc.UnaryCallable<GetRegionInstanceGroupHttpRequest,InstanceGroup>	getRegionInstanceGroupCallable() Returns the specified instance group resource.
RegionInstanceGroupSettings	getSettings()
RegionInstanceGroupStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse	listInstancesRegionInstanceGroups(ListInstancesRegionInstanceGroupsHttpRequest request) Lists the instances in the specified instance group and displays information about the named ports.
RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse	listInstancesRegionInstanceGroups(ProjectRegionInstanceGroupName instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource) Lists the instances in the specified instance group and displays information about the named ports.
RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse	listInstancesRegionInstanceGroups(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<ListInstancesRegionInstanceGroupsHttpRequest,RegionInstanceGroupsListInstances>	listInstancesRegionInstanceGroupsCallable() Lists the instances in the specified instance group and displays information about the named ports.
com.google.api.gax.rpc.UnaryCallable<ListInstancesRegionInstanceGroupsHttpRequest,RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse>	listInstancesRegionInstanceGroupsPagedCallable() Lists the instances in the specified instance group and displays information about the named ports.
RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse	listRegionInstanceGroups(ListRegionInstanceGroupsHttpRequest request) Retrieves the list of instance group resources contained within the specified region.
RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse	listRegionInstanceGroups(ProjectRegionName region) Retrieves the list of instance group resources contained within the specified region.
RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse	listRegionInstanceGroups(String region) Retrieves the list of instance group resources contained within the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsHttpRequest,RegionInstanceGroupList>	listRegionInstanceGroupsCallable() Retrieves the list of instance group resources contained within the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsHttpRequest,RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse>	listRegionInstanceGroupsPagedCallable() Retrieves the list of instance group resources contained within the specified region.
Operation	setNamedPortsRegionInstanceGroup(ProjectRegionInstanceGroupName instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource) Sets the named ports for the specified regional instance group.
Operation	setNamedPortsRegionInstanceGroup(SetNamedPortsRegionInstanceGroupHttpRequest request) Sets the named ports for the specified regional instance group.
Operation	setNamedPortsRegionInstanceGroup(String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource) Sets the named ports for the specified regional instance group.
com.google.api.gax.rpc.UnaryCallable<SetNamedPortsRegionInstanceGroupHttpRequest,Operation>	setNamedPortsRegionInstanceGroupCallable() 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

RegionInstanceGroupClient

protected RegionInstanceGroupClient(RegionInstanceGroupSettings settings)
                             throws IOException

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

RegionInstanceGroupClient

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

Method Detail

create

public static final RegionInstanceGroupClient create()
                                              throws IOException

Constructs an instance of RegionInstanceGroupClient with default settings.

Throws:

IOException

create

public static final RegionInstanceGroupClient create(RegionInstanceGroupSettings settings)
                                              throws IOException

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

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

getSettings

public final RegionInstanceGroupSettings getSettings()

getStub

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

getRegionInstanceGroup

@BetaApi
public final InstanceGroup getRegionInstanceGroup(ProjectRegionInstanceGroupName instanceGroup)

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   InstanceGroup response = regionInstanceGroupClient.getRegionInstanceGroup(instanceGroup);
 }
 

Parameters:

instanceGroup - Name of the instance group resource to return.

Throws:

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

getRegionInstanceGroup

@BetaApi
public final InstanceGroup getRegionInstanceGroup(String instanceGroup)

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   InstanceGroup response = regionInstanceGroupClient.getRegionInstanceGroup(instanceGroup.toString());
 }
 

Parameters:

instanceGroup - Name of the instance group resource to return.

Throws:

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

getRegionInstanceGroup

@BetaApi
public final InstanceGroup getRegionInstanceGroup(GetRegionInstanceGroupHttpRequest request)

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   GetRegionInstanceGroupHttpRequest request = GetRegionInstanceGroupHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .build();
   InstanceGroup response = regionInstanceGroupClient.getRegionInstanceGroup(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

getRegionInstanceGroupCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetRegionInstanceGroupHttpRequest,InstanceGroup> getRegionInstanceGroupCallable()

Returns the specified instance group resource.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   GetRegionInstanceGroupHttpRequest request = GetRegionInstanceGroupHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .build();
   ApiFuture<InstanceGroup> future = regionInstanceGroupClient.getRegionInstanceGroupCallable().futureCall(request);
   // Do something
   InstanceGroup response = future.get();
 }
 

listRegionInstanceGroups

@BetaApi
public final RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse listRegionInstanceGroups(ProjectRegionName region)

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

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (InstanceGroup element : regionInstanceGroupClient.listRegionInstanceGroups(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listRegionInstanceGroups

@BetaApi
public final RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse listRegionInstanceGroups(String region)

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

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (InstanceGroup element : regionInstanceGroupClient.listRegionInstanceGroups(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listRegionInstanceGroups

@BetaApi
public final RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse listRegionInstanceGroups(ListRegionInstanceGroupsHttpRequest request)

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

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionInstanceGroupsHttpRequest request = ListRegionInstanceGroupsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (InstanceGroup element : regionInstanceGroupClient.listRegionInstanceGroups(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

listRegionInstanceGroupsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsHttpRequest,RegionInstanceGroupClient.ListRegionInstanceGroupsPagedResponse> listRegionInstanceGroupsPagedCallable()

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

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionInstanceGroupsHttpRequest request = ListRegionInstanceGroupsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListRegionInstanceGroupsPagedResponse> future = regionInstanceGroupClient.listRegionInstanceGroupsPagedCallable().futureCall(request);
   // Do something
   for (InstanceGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionInstanceGroupsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceGroupsHttpRequest,RegionInstanceGroupList> listRegionInstanceGroupsCallable()

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

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionInstanceGroupsHttpRequest request = ListRegionInstanceGroupsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     RegionInstanceGroupList response = regionInstanceGroupClient.listRegionInstanceGroupsCallable().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;
     }
   }
 }
 

listInstancesRegionInstanceGroups

@BetaApi
public final RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse listInstancesRegionInstanceGroups(ProjectRegionInstanceGroupName 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.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource = RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   for (InstanceWithNamedPorts element : regionInstanceGroupClient.listInstancesRegionInstanceGroups(instanceGroup, regionInstanceGroupsListInstancesRequestResource).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

regionInstanceGroupsListInstancesRequestResource -

Throws:

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

listInstancesRegionInstanceGroups

@BetaApi
public final RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse listInstancesRegionInstanceGroups(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.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource = RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   for (InstanceWithNamedPorts element : regionInstanceGroupClient.listInstancesRegionInstanceGroups(instanceGroup.toString(), regionInstanceGroupsListInstancesRequestResource).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

regionInstanceGroupsListInstancesRequestResource -

Throws:

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

listInstancesRegionInstanceGroups

@BetaApi
public final RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse listInstancesRegionInstanceGroups(ListInstancesRegionInstanceGroupsHttpRequest 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.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource = RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   ListInstancesRegionInstanceGroupsHttpRequest request = ListInstancesRegionInstanceGroupsHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .setRegionInstanceGroupsListInstancesRequestResource(regionInstanceGroupsListInstancesRequestResource)
     .build();
   for (InstanceWithNamedPorts element : regionInstanceGroupClient.listInstancesRegionInstanceGroups(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

listInstancesRegionInstanceGroupsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInstancesRegionInstanceGroupsHttpRequest,RegionInstanceGroupClient.ListInstancesRegionInstanceGroupsPagedResponse> listInstancesRegionInstanceGroupsPagedCallable()

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.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource = RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   ListInstancesRegionInstanceGroupsHttpRequest request = ListInstancesRegionInstanceGroupsHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .setRegionInstanceGroupsListInstancesRequestResource(regionInstanceGroupsListInstancesRequestResource)
     .build();
   ApiFuture<ListInstancesRegionInstanceGroupsPagedResponse> future = regionInstanceGroupClient.listInstancesRegionInstanceGroupsPagedCallable().futureCall(request);
   // Do something
   for (InstanceWithNamedPorts element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listInstancesRegionInstanceGroupsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInstancesRegionInstanceGroupsHttpRequest,RegionInstanceGroupsListInstances> listInstancesRegionInstanceGroupsCallable()

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.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource = RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   ListInstancesRegionInstanceGroupsHttpRequest request = ListInstancesRegionInstanceGroupsHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .setRegionInstanceGroupsListInstancesRequestResource(regionInstanceGroupsListInstancesRequestResource)
     .build();
   while (true) {
     RegionInstanceGroupsListInstances response = regionInstanceGroupClient.listInstancesRegionInstanceGroupsCallable().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;
     }
   }
 }
 

setNamedPortsRegionInstanceGroup

@BetaApi
public final Operation setNamedPortsRegionInstanceGroup(ProjectRegionInstanceGroupName instanceGroup,
                                                                 RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource = RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build();
   Operation response = regionInstanceGroupClient.setNamedPortsRegionInstanceGroup(instanceGroup, regionInstanceGroupsSetNamedPortsRequestResource);
 }
 

Parameters:

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

regionInstanceGroupsSetNamedPortsRequestResource -

Throws:

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

setNamedPortsRegionInstanceGroup

@BetaApi
public final Operation setNamedPortsRegionInstanceGroup(String instanceGroup,
                                                                 RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   ProjectRegionInstanceGroupName instanceGroup = ProjectRegionInstanceGroupName.of("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource = RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build();
   Operation response = regionInstanceGroupClient.setNamedPortsRegionInstanceGroup(instanceGroup.toString(), regionInstanceGroupsSetNamedPortsRequestResource);
 }
 

Parameters:

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

regionInstanceGroupsSetNamedPortsRequestResource -

Throws:

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

setNamedPortsRegionInstanceGroup

@BetaApi
public final Operation setNamedPortsRegionInstanceGroup(SetNamedPortsRegionInstanceGroupHttpRequest request)

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource = RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build();
   SetNamedPortsRegionInstanceGroupHttpRequest request = SetNamedPortsRegionInstanceGroupHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .setRegionInstanceGroupsSetNamedPortsRequestResource(regionInstanceGroupsSetNamedPortsRequestResource)
     .build();
   Operation response = regionInstanceGroupClient.setNamedPortsRegionInstanceGroup(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

setNamedPortsRegionInstanceGroupCallable

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

Sets the named ports for the specified regional instance group.

Sample code:

 try (RegionInstanceGroupClient regionInstanceGroupClient = RegionInstanceGroupClient.create()) {
   String formattedInstanceGroup = ProjectRegionInstanceGroupName.format("[PROJECT]", "[REGION]", "[INSTANCE_GROUP]");
   RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource = RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build();
   SetNamedPortsRegionInstanceGroupHttpRequest request = SetNamedPortsRegionInstanceGroupHttpRequest.newBuilder()
     .setInstanceGroup(formattedInstanceGroup)
     .setRegionInstanceGroupsSetNamedPortsRequestResource(regionInstanceGroupsSetNamedPortsRequestResource)
     .build();
   ApiFuture<Operation> future = regionInstanceGroupClient.setNamedPortsRegionInstanceGroupCallable().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