com.google.api.services.compute

Class Compute.InstanceGroupManagers

java.lang.Object

com.google.api.services.compute.Compute.InstanceGroupManagers

Enclosing class:

Compute

public class Compute.InstanceGroupManagers
extends java.lang.Object

The "instanceGroupManagers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Compute.InstanceGroupManagers.AbandonInstances
class	Compute.InstanceGroupManagers.AggregatedList
class	Compute.InstanceGroupManagers.ApplyUpdatesToInstances
class	Compute.InstanceGroupManagers.CreateInstances
class	Compute.InstanceGroupManagers.Delete
class	Compute.InstanceGroupManagers.DeleteInstances
class	Compute.InstanceGroupManagers.Get
class	Compute.InstanceGroupManagers.Insert
class	Compute.InstanceGroupManagers.List
class	Compute.InstanceGroupManagers.ListManagedInstances
class	Compute.InstanceGroupManagers.Patch
class	Compute.InstanceGroupManagers.RecreateInstances
class	Compute.InstanceGroupManagers.Resize
class	Compute.InstanceGroupManagers.SetInstanceTemplate
class	Compute.InstanceGroupManagers.SetTargetPools

Constructor Summary

Constructors

Constructor and Description
InstanceGroupManagers()

Method Summary

Modifier and Type	Method and Description
Compute.InstanceGroupManagers.AbandonInstances	abandonInstances(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersAbandonInstancesRequest content) Flags the specified instances to be removed from the managed instance group.
Compute.InstanceGroupManagers.AggregatedList	aggregatedList(java.lang.String project) Retrieves the list of managed instance groups and groups them by zone.
Compute.InstanceGroupManagers.ApplyUpdatesToInstances	applyUpdatesToInstances(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersApplyUpdatesRequest content) Apply changes to selected instances on the managed instance group.
Compute.InstanceGroupManagers.CreateInstances	createInstances(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersCreateInstancesRequest content) Creates instances with per-instance configs in this managed instance group.
Compute.InstanceGroupManagers.Delete	delete(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager) Deletes the specified managed instance group and all of the instances in that group.
Compute.InstanceGroupManagers.DeleteInstances	deleteInstances(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersDeleteInstancesRequest content) Flags the specified instances in the managed instance group for immediate deletion.
Compute.InstanceGroupManagers.Get	get(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager) Returns all of the details about the specified managed instance group.
Compute.InstanceGroupManagers.Insert	insert(java.lang.String project, java.lang.String zone, InstanceGroupManager content) Creates a managed instance group using the information that you specify in the request.
Compute.InstanceGroupManagers.List	list(java.lang.String project, java.lang.String zone) Retrieves a list of managed instance groups that are contained within the specified project and zone.
Compute.InstanceGroupManagers.ListManagedInstances	listManagedInstances(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager) Lists all of the instances in the managed instance group.
Compute.InstanceGroupManagers.Patch	patch(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManager content) Updates a managed instance group using the information that you specify in the request.
Compute.InstanceGroupManagers.RecreateInstances	recreateInstances(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersRecreateInstancesRequest content) Flags the specified instances in the managed instance group to be immediately recreated.
Compute.InstanceGroupManagers.Resize	resize(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, java.lang.Integer size) Resizes the managed instance group.
Compute.InstanceGroupManagers.SetInstanceTemplate	setInstanceTemplate(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersSetInstanceTemplateRequest content) Specifies the instance template to use when creating new instances in this group.
Compute.InstanceGroupManagers.SetTargetPools	setTargetPools(java.lang.String project, java.lang.String zone, java.lang.String instanceGroupManager, InstanceGroupManagersSetTargetPoolsRequest content) Modifies the target pools to which all instances in this managed instance group are assigned.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceGroupManagers

public InstanceGroupManagers()

Method Detail

abandonInstances

public Compute.InstanceGroupManagers.AbandonInstances abandonInstances(java.lang.String project,
                                                                       java.lang.String zone,
                                                                       java.lang.String instanceGroupManager,
                                                                       InstanceGroupManagersAbandonInstancesRequest content)
                                                                throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.abandonInstances". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersAbandonInstancesRequest

Returns:

the request

Throws:

java.io.IOException

aggregatedList

public Compute.InstanceGroupManagers.AggregatedList aggregatedList(java.lang.String project)
                                                            throws java.io.IOException

Retrieves the list of managed instance groups and groups them by zone. Create a request for the method "instanceGroupManagers.aggregatedList". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

Returns:

the request

Throws:

java.io.IOException

applyUpdatesToInstances

public Compute.InstanceGroupManagers.ApplyUpdatesToInstances applyUpdatesToInstances(java.lang.String project,
                                                                                     java.lang.String zone,
                                                                                     java.lang.String instanceGroupManager,
                                                                                     InstanceGroupManagersApplyUpdatesRequest content)
                                                                              throws java.io.IOException

Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. Create a request for the method "instanceGroupManagers.applyUpdatesToInstances". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located. Should conform to RFC1035.

instanceGroupManager - The name of the managed instance group, should conform to RFC1035.

content - the InstanceGroupManagersApplyUpdatesRequest

Returns:

the request

Throws:

java.io.IOException

createInstances

public Compute.InstanceGroupManagers.CreateInstances createInstances(java.lang.String project,
                                                                     java.lang.String zone,
                                                                     java.lang.String instanceGroupManager,
                                                                     InstanceGroupManagersCreateInstancesRequest content)
                                                              throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.createInstances". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located. It should conform to RFC1035.

instanceGroupManager - The name of the managed instance group. It should conform to RFC1035.

content - the InstanceGroupManagersCreateInstancesRequest

Returns:

the request

Throws:

java.io.IOException

delete

public Compute.InstanceGroupManagers.Delete delete(java.lang.String project,
                                                   java.lang.String zone,
                                                   java.lang.String instanceGroupManager)
                                            throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.delete". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group to delete.

Returns:

the request

Throws:

java.io.IOException

deleteInstances

public Compute.InstanceGroupManagers.DeleteInstances deleteInstances(java.lang.String project,
                                                                     java.lang.String zone,
                                                                     java.lang.String instanceGroupManager,
                                                                     InstanceGroupManagersDeleteInstancesRequest content)
                                                              throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.deleteInstances". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersDeleteInstancesRequest

Returns:

the request

Throws:

java.io.IOException

get

public Compute.InstanceGroupManagers.Get get(java.lang.String project,
                                             java.lang.String zone,
                                             java.lang.String instanceGroupManager)
                                      throws java.io.IOException

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. Create a request for the method "instanceGroupManagers.get". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

Returns:

the request

Throws:

java.io.IOException

insert

public Compute.InstanceGroupManagers.Insert insert(java.lang.String project,
                                                   java.lang.String zone,
                                                   InstanceGroupManager content)
                                            throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.insert". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where you want to create the managed instance group.

content - the InstanceGroupManager

Returns:

the request

Throws:

java.io.IOException

list

public Compute.InstanceGroupManagers.List list(java.lang.String project,
                                               java.lang.String zone)
                                        throws java.io.IOException

Retrieves a list of managed instance groups that are contained within the specified project and zone. Create a request for the method "instanceGroupManagers.list". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

Returns:

the request

Throws:

java.io.IOException

listManagedInstances

public Compute.InstanceGroupManagers.ListManagedInstances listManagedInstances(java.lang.String project,
                                                                               java.lang.String zone,
                                                                               java.lang.String instanceGroupManager)
                                                                        throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.listManagedInstances". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

Returns:

the request

Throws:

java.io.IOException

patch

public Compute.InstanceGroupManagers.Patch patch(java.lang.String project,
                                                 java.lang.String zone,
                                                 java.lang.String instanceGroupManager,
                                                 InstanceGroupManager content)
                                          throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.patch". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where you want to create the managed instance group.

instanceGroupManager - The name of the instance group manager.

content - the InstanceGroupManager

Returns:

the request

Throws:

java.io.IOException

recreateInstances

public Compute.InstanceGroupManagers.RecreateInstances recreateInstances(java.lang.String project,
                                                                         java.lang.String zone,
                                                                         java.lang.String instanceGroupManager,
                                                                         InstanceGroupManagersRecreateInstancesRequest content)
                                                                  throws java.io.IOException

Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. 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 the recreating 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. Create a request for the method "instanceGroupManagers.recreateInstances". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersRecreateInstancesRequest

Returns:

the request

Throws:

java.io.IOException

resize

public Compute.InstanceGroupManagers.Resize resize(java.lang.String project,
                                                   java.lang.String zone,
                                                   java.lang.String instanceGroupManager,
                                                   java.lang.Integer size)
                                            throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.resize". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

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

the request

Throws:

java.io.IOException

setInstanceTemplate

public Compute.InstanceGroupManagers.SetInstanceTemplate setInstanceTemplate(java.lang.String project,
                                                                             java.lang.String zone,
                                                                             java.lang.String instanceGroupManager,
                                                                             InstanceGroupManagersSetInstanceTemplateRequest content)
                                                                      throws java.io.IOException

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 recreate them. Create a request for the method "instanceGroupManagers.setInstanceTemplate". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersSetInstanceTemplateRequest

Returns:

the request

Throws:

java.io.IOException

setTargetPools

public Compute.InstanceGroupManagers.SetTargetPools setTargetPools(java.lang.String project,
                                                                   java.lang.String zone,
                                                                   java.lang.String instanceGroupManager,
                                                                   InstanceGroupManagersSetTargetPoolsRequest content)
                                                            throws java.io.IOException

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. Create a request for the method "instanceGroupManagers.setTargetPools". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersSetTargetPoolsRequest

Returns:

the request

Throws:

java.io.IOException