Class InstanceGroupManagersClient (1.6.0-beta)

public class InstanceGroupManagersClient implements BackgroundResource

Service Description: The InstanceGroupManagers 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 (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManager response =
       instanceGroupManagersClient.get(project, zone, instanceGroupManager);
 }

Note: close() needs to be called on the InstanceGroupManagersClient 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:

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.
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.
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 InstanceGroupManagersSettings to create(). For example:

To customize credentials:


 InstanceGroupManagersSettings instanceGroupManagersSettings =
     InstanceGroupManagersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create(instanceGroupManagersSettings);

To customize the endpoint:


 InstanceGroupManagersSettings instanceGroupManagersSettings =
     InstanceGroupManagersSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create(instanceGroupManagersSettings);

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

Inheritance

java.lang.Object > InstanceGroupManagersClient

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)

Constructors

InstanceGroupManagersClient(InstanceGroupManagersSettings settings)

protected InstanceGroupManagersClient(InstanceGroupManagersSettings settings)

Constructs an instance of InstanceGroupManagersClient, 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	`InstanceGroupManagersSettings`

InstanceGroupManagersClient(InstanceGroupManagersStub stub)

protected InstanceGroupManagersClient(InstanceGroupManagersStub stub)

Parameter

Name	Description
stub	`InstanceGroupManagersStub`

Methods

abandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> abandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request)

Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   AbandonInstancesInstanceGroupManagerRequest request =
       AbandonInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersAbandonInstancesRequestResource(
               InstanceGroupManagersAbandonInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.abandonInstancesAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

abandonInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersAbandonInstancesRequest instanceGroupManagersAbandonInstancesRequestResource)

public final OperationFuture<Operation,Operation> abandonInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersAbandonInstancesRequest instanceGroupManagersAbandonInstancesRequestResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersAbandonInstancesRequest
       instanceGroupManagersAbandonInstancesRequestResource =
           InstanceGroupManagersAbandonInstancesRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .abandonInstancesAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersAbandonInstancesRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.
instanceGroupManagersAbandonInstancesRequestResource	`InstanceGroupManagersAbandonInstancesRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

abandonInstancesCallable()

public final UnaryCallable<AbandonInstancesInstanceGroupManagerRequest,Operation> abandonInstancesCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   AbandonInstancesInstanceGroupManagerRequest request =
       AbandonInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersAbandonInstancesRequestResource(
               InstanceGroupManagersAbandonInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<AbandonInstancesInstanceGroupManagerRequest,Operation>

abandonInstancesOperationCallable()

public final OperationCallable<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation> abandonInstancesOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   AbandonInstancesInstanceGroupManagerRequest request =
       AbandonInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersAbandonInstancesRequestResource(
               InstanceGroupManagersAbandonInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation>

aggregatedList(AggregatedListInstanceGroupManagersRequest request)

public final InstanceGroupManagersClient.AggregatedListPagedResponse aggregatedList(AggregatedListInstanceGroupManagersRequest request)

Retrieves the list of managed instance groups and groups them by zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   AggregatedListInstanceGroupManagersRequest request =
       AggregatedListInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry

Parameter

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

Returns

Type	Description
InstanceGroupManagersClient.AggregatedListPagedResponse

aggregatedList(String project)

public final InstanceGroupManagersClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of managed instance groups and groups them by zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   for (Map.Entry

Parameter

Name	Description
project	`String` Project ID for this request.

Returns

Type	Description
InstanceGroupManagersClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList> aggregatedListCallable()

Retrieves the list of managed instance groups and groups them by zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   AggregatedListInstanceGroupManagersRequest request =
       AggregatedListInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     InstanceGroupManagerAggregatedList response =
         instanceGroupManagersClient.aggregatedListCallable().call(request);
     for (Map.Entry

Returns

Type	Description
UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagersClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of managed instance groups and groups them by zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   AggregatedListInstanceGroupManagersRequest request =
       AggregatedListInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<>

Returns

Type	Description
UnaryCallable<AggregatedListInstanceGroupManagersRequest,AggregatedListPagedResponse>

applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request)

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ApplyUpdatesToInstancesInstanceGroupManagerRequest request =
       ApplyUpdatesToInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersApplyUpdatesRequestResource(
               InstanceGroupManagersApplyUpdatesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.applyUpdatesToInstancesAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

applyUpdatesToInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersApplyUpdatesRequest instanceGroupManagersApplyUpdatesRequestResource)

public final OperationFuture<Operation,Operation> applyUpdatesToInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersApplyUpdatesRequest instanceGroupManagersApplyUpdatesRequestResource)

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersApplyUpdatesRequest instanceGroupManagersApplyUpdatesRequestResource =
       InstanceGroupManagersApplyUpdatesRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .applyUpdatesToInstancesAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersApplyUpdatesRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. Should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group, should conform to RFC1035.
instanceGroupManagersApplyUpdatesRequestResource	`InstanceGroupManagersApplyUpdatesRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

applyUpdatesToInstancesCallable()

public final UnaryCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation> applyUpdatesToInstancesCallable()

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ApplyUpdatesToInstancesInstanceGroupManagerRequest request =
       ApplyUpdatesToInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersApplyUpdatesRequestResource(
               InstanceGroupManagersApplyUpdatesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation>

applyUpdatesToInstancesOperationCallable()

public final OperationCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation> applyUpdatesToInstancesOperationCallable()

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ApplyUpdatesToInstancesInstanceGroupManagerRequest request =
       ApplyUpdatesToInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersApplyUpdatesRequestResource(
               InstanceGroupManagersApplyUpdatesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation>

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

create()

public static final InstanceGroupManagersClient create()

Constructs an instance of InstanceGroupManagersClient with default settings.

Returns

Type	Description
InstanceGroupManagersClient

Exceptions

Type	Description
IOException

create(InstanceGroupManagersSettings settings)

public static final InstanceGroupManagersClient create(InstanceGroupManagersSettings settings)

Constructs an instance of InstanceGroupManagersClient, 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	`InstanceGroupManagersSettings`

Returns

Type	Description
InstanceGroupManagersClient

Exceptions

Type	Description
IOException

create(InstanceGroupManagersStub stub)

public static final InstanceGroupManagersClient create(InstanceGroupManagersStub stub)

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

Parameter

Name	Description
stub	`InstanceGroupManagersStub`

Returns

Type	Description
InstanceGroupManagersClient

createInstancesAsync(CreateInstancesInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> createInstancesAsync(CreateInstancesInstanceGroupManagerRequest request)

Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   CreateInstancesInstanceGroupManagerRequest request =
       CreateInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersCreateInstancesRequestResource(
               InstanceGroupManagersCreateInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.createInstancesAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

createInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersCreateInstancesRequest instanceGroupManagersCreateInstancesRequestResource)

public final OperationFuture<Operation,Operation> createInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersCreateInstancesRequest instanceGroupManagersCreateInstancesRequestResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersCreateInstancesRequest
       instanceGroupManagersCreateInstancesRequestResource =
           InstanceGroupManagersCreateInstancesRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .createInstancesAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersCreateInstancesRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group. It should conform to RFC1035.
instanceGroupManagersCreateInstancesRequestResource	`InstanceGroupManagersCreateInstancesRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

createInstancesCallable()

public final UnaryCallable<CreateInstancesInstanceGroupManagerRequest,Operation> createInstancesCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   CreateInstancesInstanceGroupManagerRequest request =
       CreateInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersCreateInstancesRequestResource(
               InstanceGroupManagersCreateInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateInstancesInstanceGroupManagerRequest,Operation>

createInstancesOperationCallable()

public final OperationCallable<CreateInstancesInstanceGroupManagerRequest,Operation,Operation> createInstancesOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   CreateInstancesInstanceGroupManagerRequest request =
       CreateInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersCreateInstancesRequestResource(
               InstanceGroupManagersCreateInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CreateInstancesInstanceGroupManagerRequest,Operation,Operation>

deleteAsync(DeleteInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteInstanceGroupManagerRequest request)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeleteInstanceGroupManagerRequest request =
       DeleteInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.deleteAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String zone, String instanceGroupManager)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String instanceGroupManager)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   Operation response =
       instanceGroupManagersClient.deleteAsync(project, zone, instanceGroupManager).get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteInstanceGroupManagerRequest,Operation> deleteCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeleteInstanceGroupManagerRequest request =
       DeleteInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteInstanceGroupManagerRequest,Operation>

deleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> deleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request)

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeleteInstancesInstanceGroupManagerRequest request =
       DeleteInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersDeleteInstancesRequestResource(
               InstanceGroupManagersDeleteInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.deleteInstancesAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeleteInstancesRequest instanceGroupManagersDeleteInstancesRequestResource)

public final OperationFuture<Operation,Operation> deleteInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeleteInstancesRequest instanceGroupManagersDeleteInstancesRequestResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersDeleteInstancesRequest
       instanceGroupManagersDeleteInstancesRequestResource =
           InstanceGroupManagersDeleteInstancesRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .deleteInstancesAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersDeleteInstancesRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.
instanceGroupManagersDeleteInstancesRequestResource	`InstanceGroupManagersDeleteInstancesRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteInstancesCallable()

public final UnaryCallable<DeleteInstancesInstanceGroupManagerRequest,Operation> deleteInstancesCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeleteInstancesInstanceGroupManagerRequest request =
       DeleteInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersDeleteInstancesRequestResource(
               InstanceGroupManagersDeleteInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteInstancesInstanceGroupManagerRequest,Operation>

deleteInstancesOperationCallable()

public final OperationCallable<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation> deleteInstancesOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeleteInstancesInstanceGroupManagerRequest request =
       DeleteInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersDeleteInstancesRequestResource(
               InstanceGroupManagersDeleteInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteInstanceGroupManagerRequest,Operation,Operation> deleteOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeleteInstanceGroupManagerRequest request =
       DeleteInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteInstanceGroupManagerRequest,Operation,Operation>

deletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> deletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request)

Deletes selected per-instance configs for the managed instance group.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeletePerInstanceConfigsInstanceGroupManagerRequest request =
       DeletePerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersDeletePerInstanceConfigsReqResource(
               InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.deletePerInstanceConfigsAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deletePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeletePerInstanceConfigsReq instanceGroupManagersDeletePerInstanceConfigsReqResource)

public final OperationFuture<Operation,Operation> deletePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeletePerInstanceConfigsReq instanceGroupManagersDeletePerInstanceConfigsReqResource)

Deletes selected per-instance configs for the managed instance group.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersDeletePerInstanceConfigsReq
       instanceGroupManagersDeletePerInstanceConfigsReqResource =
           InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .deletePerInstanceConfigsAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersDeletePerInstanceConfigsReqResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group. It should conform to RFC1035.
instanceGroupManagersDeletePerInstanceConfigsReqResource	`InstanceGroupManagersDeletePerInstanceConfigsReq` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

deletePerInstanceConfigsCallable()

public final UnaryCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation> deletePerInstanceConfigsCallable()

Deletes selected per-instance configs for the managed instance group.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeletePerInstanceConfigsInstanceGroupManagerRequest request =
       DeletePerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersDeletePerInstanceConfigsReqResource(
               InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation>

deletePerInstanceConfigsOperationCallable()

public final OperationCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> deletePerInstanceConfigsOperationCallable()

Deletes selected per-instance configs for the managed instance group.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   DeletePerInstanceConfigsInstanceGroupManagerRequest request =
       DeletePerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersDeletePerInstanceConfigsReqResource(
               InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation>

get(GetInstanceGroupManagerRequest request)

public final InstanceGroupManager get(GetInstanceGroupManagerRequest request)

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   GetInstanceGroupManagerRequest request =
       GetInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   InstanceGroupManager response = instanceGroupManagersClient.get(request);
 }

Parameter

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

Returns

Type	Description
InstanceGroupManager

get(String project, String zone, String instanceGroupManager)

public final InstanceGroupManager get(String project, String zone, String instanceGroupManager)

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManager response =
       instanceGroupManagersClient.get(project, zone, instanceGroupManager);
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.

Returns

Type	Description
InstanceGroupManager

getCallable()

public final UnaryCallable<GetInstanceGroupManagerRequest,InstanceGroupManager> getCallable()

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   GetInstanceGroupManagerRequest request =
       GetInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetInstanceGroupManagerRequest,InstanceGroupManager>

getSettings()

public final InstanceGroupManagersSettings getSettings()

Returns

Type	Description
InstanceGroupManagersSettings

getStub()

public InstanceGroupManagersStub getStub()

Returns

Type	Description
InstanceGroupManagersStub

insertAsync(InsertInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertInstanceGroupManagerRequest request)

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   InsertInstanceGroupManagerRequest request =
       InsertInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.insertAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String zone, InstanceGroupManager instanceGroupManagerResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, InstanceGroupManager instanceGroupManagerResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   InstanceGroupManager instanceGroupManagerResource = InstanceGroupManager.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .insertAsync(project, zone, instanceGroupManagerResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where you want to create the managed instance group.
instanceGroupManagerResource	`InstanceGroupManager` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertInstanceGroupManagerRequest,Operation> insertCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   InsertInstanceGroupManagerRequest request =
       InsertInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<InsertInstanceGroupManagerRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertInstanceGroupManagerRequest,Operation,Operation> insertOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   InsertInstanceGroupManagerRequest request =
       InsertInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<InsertInstanceGroupManagerRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListInstanceGroupManagersRequest request)

public final InstanceGroupManagersClient.ListPagedResponse list(ListInstanceGroupManagersRequest request)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListInstanceGroupManagersRequest request =
       ListInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (InstanceGroupManager element : instanceGroupManagersClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
InstanceGroupManagersClient.ListPagedResponse

list(String project, String zone)

public final InstanceGroupManagersClient.ListPagedResponse list(String project, String zone)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (InstanceGroupManager element :
       instanceGroupManagersClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.

Returns

Type	Description
InstanceGroupManagersClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListInstanceGroupManagersRequest,InstanceGroupManagerList> listCallable()

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListInstanceGroupManagersRequest request =
       ListInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     InstanceGroupManagerList response =
         instanceGroupManagersClient.listCallable().call(request);
     for (InstanceGroupManager 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<ListInstanceGroupManagersRequest,InstanceGroupManagerList>

listErrors(ListErrorsInstanceGroupManagersRequest request)

public final InstanceGroupManagersClient.ListErrorsPagedResponse listErrors(ListErrorsInstanceGroupManagersRequest request)

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListErrorsInstanceGroupManagersRequest request =
       ListErrorsInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (InstanceManagedByIgmError element :
       instanceGroupManagersClient.listErrors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
InstanceGroupManagersClient.ListErrorsPagedResponse

listErrors(String project, String zone, String instanceGroupManager)

public final InstanceGroupManagersClient.ListErrorsPagedResponse listErrors(String project, String zone, String instanceGroupManager)

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   for (InstanceManagedByIgmError element :
       instanceGroupManagersClient
           .listErrors(project, zone, instanceGroupManager)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)\|1-9{0,19}.

Returns

Type	Description
InstanceGroupManagersClient.ListErrorsPagedResponse

listErrorsCallable()

public final UnaryCallable<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse> listErrorsCallable()

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListErrorsInstanceGroupManagersRequest request =
       ListErrorsInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     InstanceGroupManagersListErrorsResponse response =
         instanceGroupManagersClient.listErrorsCallable().call(request);
     for (InstanceManagedByIgmError 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<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse>

listErrorsPagedCallable()

public final UnaryCallable<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersClient.ListErrorsPagedResponse> listErrorsPagedCallable()

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListErrorsInstanceGroupManagersRequest request =
       ListErrorsInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListErrorsInstanceGroupManagersRequest,ListErrorsPagedResponse>

listManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request)

public final InstanceGroupManagersClient.ListManagedInstancesPagedResponse listManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListManagedInstancesInstanceGroupManagersRequest request =
       ListManagedInstancesInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (ManagedInstance element :
       instanceGroupManagersClient.listManagedInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
InstanceGroupManagersClient.ListManagedInstancesPagedResponse

listManagedInstances(String project, String zone, String instanceGroupManager)

public final InstanceGroupManagersClient.ListManagedInstancesPagedResponse listManagedInstances(String project, String zone, String instanceGroupManager)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   for (ManagedInstance element :
       instanceGroupManagersClient
           .listManagedInstances(project, zone, instanceGroupManager)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.

Returns

Type	Description
InstanceGroupManagersClient.ListManagedInstancesPagedResponse

listManagedInstancesCallable()

public final UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse> listManagedInstancesCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListManagedInstancesInstanceGroupManagersRequest request =
       ListManagedInstancesInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     InstanceGroupManagersListManagedInstancesResponse response =
         instanceGroupManagersClient.listManagedInstancesCallable().call(request);
     for (ManagedInstance 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<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse>

listManagedInstancesPagedCallable()

public final UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersClient.ListManagedInstancesPagedResponse> listManagedInstancesPagedCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListManagedInstancesInstanceGroupManagersRequest request =
       ListManagedInstancesInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,ListManagedInstancesPagedResponse>

listPagedCallable()

public final UnaryCallable<ListInstanceGroupManagersRequest,InstanceGroupManagersClient.ListPagedResponse> listPagedCallable()

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListInstanceGroupManagersRequest request =
       ListInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListInstanceGroupManagersRequest,ListPagedResponse>

listPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request)

public final InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse listPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request)

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListPerInstanceConfigsInstanceGroupManagersRequest request =
       ListPerInstanceConfigsInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (PerInstanceConfig element :
       instanceGroupManagersClient.listPerInstanceConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse

listPerInstanceConfigs(String project, String zone, String instanceGroupManager)

public final InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse listPerInstanceConfigs(String project, String zone, String instanceGroupManager)

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   for (PerInstanceConfig element :
       instanceGroupManagersClient
           .listPerInstanceConfigs(project, zone, instanceGroupManager)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group. It should conform to RFC1035.

Returns

Type	Description
InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse

listPerInstanceConfigsCallable()

public final UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp> listPerInstanceConfigsCallable()

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListPerInstanceConfigsInstanceGroupManagersRequest request =
       ListPerInstanceConfigsInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     InstanceGroupManagersListPerInstanceConfigsResp response =
         instanceGroupManagersClient.listPerInstanceConfigsCallable().call(request);
     for (PerInstanceConfig 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<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp>

listPerInstanceConfigsPagedCallable()

public final UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse> listPerInstanceConfigsPagedCallable()

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ListPerInstanceConfigsInstanceGroupManagersRequest request =
       ListPerInstanceConfigsInstanceGroupManagersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,ListPerInstanceConfigsPagedResponse>

patchAsync(PatchInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchInstanceGroupManagerRequest request)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   PatchInstanceGroupManagerRequest request =
       PatchInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.patchAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String zone, String instanceGroupManager, InstanceGroupManager instanceGroupManagerResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String zone, String instanceGroupManager, InstanceGroupManager instanceGroupManagerResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManager instanceGroupManagerResource = InstanceGroupManager.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .patchAsync(project, zone, instanceGroupManager, instanceGroupManagerResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where you want to create the managed instance group.
instanceGroupManager	`String` The name of the instance group manager.
instanceGroupManagerResource	`InstanceGroupManager` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchInstanceGroupManagerRequest,Operation> patchCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   PatchInstanceGroupManagerRequest request =
       PatchInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<PatchInstanceGroupManagerRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchInstanceGroupManagerRequest,Operation,Operation> patchOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   PatchInstanceGroupManagerRequest request =
       PatchInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<PatchInstanceGroupManagerRequest,Operation,Operation>

patchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> patchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request)

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   PatchPerInstanceConfigsInstanceGroupManagerRequest request =
       PatchPerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersPatchPerInstanceConfigsReqResource(
               InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.patchPerInstanceConfigsAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchPerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersPatchPerInstanceConfigsReq instanceGroupManagersPatchPerInstanceConfigsReqResource)

public final OperationFuture<Operation,Operation> patchPerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersPatchPerInstanceConfigsReq instanceGroupManagersPatchPerInstanceConfigsReqResource)

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersPatchPerInstanceConfigsReq
       instanceGroupManagersPatchPerInstanceConfigsReqResource =
           InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .patchPerInstanceConfigsAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersPatchPerInstanceConfigsReqResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group. It should conform to RFC1035.
instanceGroupManagersPatchPerInstanceConfigsReqResource	`InstanceGroupManagersPatchPerInstanceConfigsReq` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

patchPerInstanceConfigsCallable()

public final UnaryCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation> patchPerInstanceConfigsCallable()

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   PatchPerInstanceConfigsInstanceGroupManagerRequest request =
       PatchPerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersPatchPerInstanceConfigsReqResource(
               InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation>

patchPerInstanceConfigsOperationCallable()

public final OperationCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> patchPerInstanceConfigsOperationCallable()

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   PatchPerInstanceConfigsInstanceGroupManagerRequest request =
       PatchPerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersPatchPerInstanceConfigsReqResource(
               InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation>

recreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> recreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request)

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   RecreateInstancesInstanceGroupManagerRequest request =
       RecreateInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersRecreateInstancesRequestResource(
               InstanceGroupManagersRecreateInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.recreateInstancesAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

recreateInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersRecreateInstancesRequest instanceGroupManagersRecreateInstancesRequestResource)

public final OperationFuture<Operation,Operation> recreateInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersRecreateInstancesRequest instanceGroupManagersRecreateInstancesRequestResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersRecreateInstancesRequest
       instanceGroupManagersRecreateInstancesRequestResource =
           InstanceGroupManagersRecreateInstancesRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .recreateInstancesAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersRecreateInstancesRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.
instanceGroupManagersRecreateInstancesRequestResource	`InstanceGroupManagersRecreateInstancesRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

recreateInstancesCallable()

public final UnaryCallable<RecreateInstancesInstanceGroupManagerRequest,Operation> recreateInstancesCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   RecreateInstancesInstanceGroupManagerRequest request =
       RecreateInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersRecreateInstancesRequestResource(
               InstanceGroupManagersRecreateInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<RecreateInstancesInstanceGroupManagerRequest,Operation>

recreateInstancesOperationCallable()

public final OperationCallable<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation> recreateInstancesOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   RecreateInstancesInstanceGroupManagerRequest request =
       RecreateInstancesInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersRecreateInstancesRequestResource(
               InstanceGroupManagersRecreateInstancesRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation>

resizeAsync(ResizeInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> resizeAsync(ResizeInstanceGroupManagerRequest request)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ResizeInstanceGroupManagerRequest request =
       ResizeInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSize(3530753)
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.resizeAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

resizeAsync(String project, String zone, String instanceGroupManager, int size)

public final OperationFuture<Operation,Operation> resizeAsync(String project, String zone, String instanceGroupManager, int size)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   int size = 3530753;
   Operation response =
       instanceGroupManagersClient.resizeAsync(project, zone, instanceGroupManager, size).get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.
size	`int` The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

Returns

Type	Description
OperationFuture<Operation,Operation>

resizeCallable()

public final UnaryCallable<ResizeInstanceGroupManagerRequest,Operation> resizeCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ResizeInstanceGroupManagerRequest request =
       ResizeInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSize(3530753)
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ResizeInstanceGroupManagerRequest,Operation>

resizeOperationCallable()

public final OperationCallable<ResizeInstanceGroupManagerRequest,Operation,Operation> resizeOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   ResizeInstanceGroupManagerRequest request =
       ResizeInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSize(3530753)
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ResizeInstanceGroupManagerRequest,Operation,Operation>

setInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> setInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   SetInstanceTemplateInstanceGroupManagerRequest request =
       SetInstanceTemplateInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersSetInstanceTemplateRequestResource(
               InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.setInstanceTemplateAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setInstanceTemplateAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetInstanceTemplateRequest instanceGroupManagersSetInstanceTemplateRequestResource)

public final OperationFuture<Operation,Operation> setInstanceTemplateAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetInstanceTemplateRequest instanceGroupManagersSetInstanceTemplateRequestResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersSetInstanceTemplateRequest
       instanceGroupManagersSetInstanceTemplateRequestResource =
           InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .setInstanceTemplateAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersSetInstanceTemplateRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.
instanceGroupManagersSetInstanceTemplateRequestResource	`InstanceGroupManagersSetInstanceTemplateRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setInstanceTemplateCallable()

public final UnaryCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation> setInstanceTemplateCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   SetInstanceTemplateInstanceGroupManagerRequest request =
       SetInstanceTemplateInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersSetInstanceTemplateRequestResource(
               InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation>

setInstanceTemplateOperationCallable()

public final OperationCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation> setInstanceTemplateOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   SetInstanceTemplateInstanceGroupManagerRequest request =
       SetInstanceTemplateInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersSetInstanceTemplateRequestResource(
               InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation>

setTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> setTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   SetTargetPoolsInstanceGroupManagerRequest request =
       SetTargetPoolsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersSetTargetPoolsRequestResource(
               InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.setTargetPoolsAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setTargetPoolsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetTargetPoolsRequest instanceGroupManagersSetTargetPoolsRequestResource)

public final OperationFuture<Operation,Operation> setTargetPoolsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetTargetPoolsRequest instanceGroupManagersSetTargetPoolsRequestResource)

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersSetTargetPoolsRequest
       instanceGroupManagersSetTargetPoolsRequestResource =
           InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .setTargetPoolsAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersSetTargetPoolsRequestResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located.
instanceGroupManager	`String` The name of the managed instance group.
instanceGroupManagersSetTargetPoolsRequestResource	`InstanceGroupManagersSetTargetPoolsRequest` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setTargetPoolsCallable()

public final UnaryCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation> setTargetPoolsCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   SetTargetPoolsInstanceGroupManagerRequest request =
       SetTargetPoolsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersSetTargetPoolsRequestResource(
               InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation>

setTargetPoolsOperationCallable()

public final OperationCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation> setTargetPoolsOperationCallable()

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   SetTargetPoolsInstanceGroupManagerRequest request =
       SetTargetPoolsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersSetTargetPoolsRequestResource(
               InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request)

public final OperationFuture<Operation,Operation> updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request)

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   UpdatePerInstanceConfigsInstanceGroupManagerRequest request =
       UpdatePerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersUpdatePerInstanceConfigsReqResource(
               InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instanceGroupManagersClient.updatePerInstanceConfigsAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

updatePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersUpdatePerInstanceConfigsReq instanceGroupManagersUpdatePerInstanceConfigsReqResource)

public final OperationFuture<Operation,Operation> updatePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersUpdatePerInstanceConfigsReq instanceGroupManagersUpdatePerInstanceConfigsReqResource)

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instanceGroupManager = "instanceGroupManager-388242077";
   InstanceGroupManagersUpdatePerInstanceConfigsReq
       instanceGroupManagersUpdatePerInstanceConfigsReqResource =
           InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build();
   Operation response =
       instanceGroupManagersClient
           .updatePerInstanceConfigsAsync(
               project,
               zone,
               instanceGroupManager,
               instanceGroupManagersUpdatePerInstanceConfigsReqResource)
           .get();
 }

Parameters

Name	Description
project	`String` Project ID for this request.
zone	`String` The name of the zone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager	`String` The name of the managed instance group. It should conform to RFC1035.
instanceGroupManagersUpdatePerInstanceConfigsReqResource	`InstanceGroupManagersUpdatePerInstanceConfigsReq` The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

updatePerInstanceConfigsCallable()

public final UnaryCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation> updatePerInstanceConfigsCallable()

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   UpdatePerInstanceConfigsInstanceGroupManagerRequest request =
       UpdatePerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersUpdatePerInstanceConfigsReqResource(
               InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation>

updatePerInstanceConfigsOperationCallable()

public final OperationCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> updatePerInstanceConfigsOperationCallable()

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Sample code:


 try (InstanceGroupManagersClient instanceGroupManagersClient =
     InstanceGroupManagersClient.create()) {
   UpdatePerInstanceConfigsInstanceGroupManagerRequest request =
       UpdatePerInstanceConfigsInstanceGroupManagerRequest.newBuilder()
           .setInstanceGroupManager("instanceGroupManager-388242077")
           .setInstanceGroupManagersUpdatePerInstanceConfigsReqResource(
               InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation>