target.apidocs.com.google.api.services.compute.Compute.InstanceGroupManagers.html Maven / Gradle / Ivy
Compute.InstanceGroupManagers (Compute Engine API v1-rev20250107-2.0.0)
com.google.api.services.compute
Class Compute.InstanceGroupManagers
- java.lang.Object
-
- com.google.api.services.compute.Compute.InstanceGroupManagers
-
-
Nested Class Summary
-
Constructor Summary
Constructors
Constructor and Description
InstanceGroupManagers()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Compute.InstanceGroupManagers.AbandonInstancesabandonInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersAbandonInstancesRequest content)
Flags the specified instances to be removed from the managed instance group.
Compute.InstanceGroupManagers.AggregatedListaggregatedList(String project)
Retrieves the list of managed instance groups and groups them by zone.
Compute.InstanceGroupManagers.ApplyUpdatesToInstancesapplyUpdatesToInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersApplyUpdatesRequest content)
Applies changes to selected instances on the managed instance group.
Compute.InstanceGroupManagers.CreateInstancescreateInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersCreateInstancesRequest content)
Creates instances with per-instance configurations in this managed instance group.
Compute.InstanceGroupManagers.Deletedelete(String project,
String zone,
String instanceGroupManager)
Deletes the specified managed instance group and all of the instances in that group.
Compute.InstanceGroupManagers.DeleteInstancesdeleteInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersDeleteInstancesRequest content)
Flags the specified instances in the managed instance group for immediate deletion.
Compute.InstanceGroupManagers.DeletePerInstanceConfigsdeletePerInstanceConfigs(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersDeletePerInstanceConfigsReq content)
Deletes selected per-instance configurations for the managed instance group.
Compute.InstanceGroupManagers.Getget(String project,
String zone,
String instanceGroupManager)
Returns all of the details about the specified managed instance group.
Compute.InstanceGroupManagers.Insertinsert(String project,
String zone,
InstanceGroupManager content)
Creates a managed instance group using the information that you specify in the request.
Compute.InstanceGroupManagers.Listlist(String project,
String zone)
Retrieves a list of managed instance groups that are contained within the specified project and
zone.
Compute.InstanceGroupManagers.ListErrorslistErrors(String project,
String zone,
String instanceGroupManager)
Lists all errors thrown by actions on instances for a given managed instance group.
Compute.InstanceGroupManagers.ListManagedInstanceslistManagedInstances(String project,
String zone,
String instanceGroupManager)
Lists all of the instances in the managed instance group.
Compute.InstanceGroupManagers.ListPerInstanceConfigslistPerInstanceConfigs(String project,
String zone,
String instanceGroupManager)
Lists all of the per-instance configurations defined for the managed instance group.
Compute.InstanceGroupManagers.Patchpatch(String project,
String zone,
String instanceGroupManager,
InstanceGroupManager content)
Updates a managed instance group using the information that you specify in the request.
Compute.InstanceGroupManagers.PatchPerInstanceConfigspatchPerInstanceConfigs(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersPatchPerInstanceConfigsReq content)
Inserts or patches per-instance configurations for the managed instance group.
Compute.InstanceGroupManagers.RecreateInstancesrecreateInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersRecreateInstancesRequest content)
Flags the specified VM instances in the managed instance group to be immediately recreated.
Compute.InstanceGroupManagers.Resizeresize(String project,
String zone,
String instanceGroupManager,
Integer size)
Resizes the managed instance group.
Compute.InstanceGroupManagers.ResumeInstancesresumeInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersResumeInstancesRequest content)
Flags the specified instances in the managed instance group to be resumed.
Compute.InstanceGroupManagers.SetInstanceTemplatesetInstanceTemplate(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersSetInstanceTemplateRequest content)
Specifies the instance template to use when creating new instances in this group.
Compute.InstanceGroupManagers.SetTargetPoolssetTargetPools(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersSetTargetPoolsRequest content)
Modifies the target pools to which all instances in this managed instance group are assigned.
Compute.InstanceGroupManagers.StartInstancesstartInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersStartInstancesRequest content)
Flags the specified instances in the managed instance group to be started.
Compute.InstanceGroupManagers.StopInstancesstopInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersStopInstancesRequest content)
Flags the specified instances in the managed instance group to be immediately stopped.
Compute.InstanceGroupManagers.SuspendInstancessuspendInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersSuspendInstancesRequest content)
Flags the specified instances in the managed instance group to be immediately suspended.
Compute.InstanceGroupManagers.UpdatePerInstanceConfigsupdatePerInstanceConfigs(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersUpdatePerInstanceConfigsReq content)
Inserts or updates per-instance configurations for the managed instance group.
-
-
Method Detail
-
abandonInstances
public Compute.InstanceGroupManagers.AbandonInstances abandonInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersAbandonInstancesRequest content)
throws 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:
IOException
-
aggregatedList
public Compute.InstanceGroupManagers.AggregatedList aggregatedList(String project)
throws IOException
Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google
recommends that you set the `returnPartialSuccess` parameter to `true`.
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:
IOException
-
applyUpdatesToInstances
public Compute.InstanceGroupManagers.ApplyUpdatesToInstances applyUpdatesToInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersApplyUpdatesRequest content)
throws IOException
Applies 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:
IOException
-
createInstances
public Compute.InstanceGroupManagers.CreateInstances createInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersCreateInstancesRequest content)
throws IOException
Creates instances with per-instance configurations 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:
IOException
-
delete
public Compute.InstanceGroupManagers.Delete delete(String project,
String zone,
String instanceGroupManager)
throws 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:
IOException
-
deleteInstances
public Compute.InstanceGroupManagers.DeleteInstances deleteInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersDeleteInstancesRequest content)
throws 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:
IOException
-
deletePerInstanceConfigs
public Compute.InstanceGroupManagers.DeletePerInstanceConfigs deletePerInstanceConfigs(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersDeletePerInstanceConfigsReq content)
throws IOException
Deletes selected per-instance configurations for the managed instance group.
Create a request for the method "instanceGroupManagers.deletePerInstanceConfigs".
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 InstanceGroupManagersDeletePerInstanceConfigsReq- Returns:
- the request
- Throws:
IOException
-
get
public Compute.InstanceGroupManagers.Get get(String project,
String zone,
String instanceGroupManager)
throws IOException
Returns all of the details about the specified managed instance group.
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:
IOException
-
insert
public Compute.InstanceGroupManagers.Insert insert(String project,
String zone,
InstanceGroupManager content)
throws 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:
IOException
-
list
public Compute.InstanceGroupManagers.List list(String project,
String zone)
throws 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:
IOException
-
listErrors
public Compute.InstanceGroupManagers.ListErrors listErrors(String project,
String zone,
String instanceGroupManager)
throws IOException
Lists all errors thrown by actions on instances for a given managed instance group. The filter
and orderBy query parameters are not supported.
Create a request for the method "instanceGroupManagers.listErrors".
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 must be a string that meets the requirements in RFC1035,
or an unsigned long integer: must match regexp pattern:
(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.- Returns:
- the request
- Throws:
IOException
-
listManagedInstances
public Compute.InstanceGroupManagers.ListManagedInstances listManagedInstances(String project,
String zone,
String instanceGroupManager)
throws 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. The orderBy
query parameter is not supported. The `pageToken` query parameter is supported only if the
group's `listManagedInstancesResults` field is set to `PAGINATED`.
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:
IOException
-
listPerInstanceConfigs
public Compute.InstanceGroupManagers.ListPerInstanceConfigs listPerInstanceConfigs(String project,
String zone,
String instanceGroupManager)
throws IOException
Lists all of the per-instance configurations defined for the managed instance group. The orderBy
query parameter is not supported.
Create a request for the method "instanceGroupManagers.listPerInstanceConfigs".
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.- Returns:
- the request
- Throws:
IOException
-
patch
public Compute.InstanceGroupManagers.Patch patch(String project,
String zone,
String instanceGroupManager,
InstanceGroupManager content)
throws 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. 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.
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:
IOException
-
patchPerInstanceConfigs
public Compute.InstanceGroupManagers.PatchPerInstanceConfigs patchPerInstanceConfigs(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersPatchPerInstanceConfigsReq content)
throws IOException
Inserts or patches per-instance configurations for the managed instance group.
perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Create a request for the method "instanceGroupManagers.patchPerInstanceConfigs".
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 InstanceGroupManagersPatchPerInstanceConfigsReq- Returns:
- the request
- Throws:
IOException
-
recreateInstances
public Compute.InstanceGroupManagers.RecreateInstances recreateInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersRecreateInstancesRequest content)
throws IOException
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.
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:
IOException
-
resize
public Compute.InstanceGroupManagers.Resize resize(String project,
String zone,
String instanceGroupManager,
Integer size)
throws 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:
IOException
-
resumeInstances
public Compute.InstanceGroupManagers.ResumeInstances resumeInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersResumeInstancesRequest content)
throws IOException
Flags the specified instances in the managed instance group to be resumed. This method increases
the targetSize and decreases the targetSuspendedSize of the managed instance group by the number
of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances
request is successful. The underlying actions take additional time. You must separately verify
the status of the RESUMING action with the listmanagedinstances method. In this request, you can
only specify instances that are suspended. For example, if an instance was previously suspended
using the suspendInstances method, it can be resumed using the resumeInstances method. If a
health check is attached to the managed instance group, the specified instances will be verified
as healthy after they are resumed. You can specify a maximum of 1000 instances with this method
per request.
Create a request for the method "instanceGroupManagers.resumeInstances".
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 InstanceGroupManagersResumeInstancesRequest- Returns:
- the request
- Throws:
IOException
-
setInstanceTemplate
public Compute.InstanceGroupManagers.SetInstanceTemplate setInstanceTemplate(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersSetInstanceTemplateRequest content)
throws 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 run recreateInstances, run
applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
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:
IOException
-
setTargetPools
public Compute.InstanceGroupManagers.SetTargetPools setTargetPools(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersSetTargetPoolsRequest content)
throws 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:
IOException
-
startInstances
public Compute.InstanceGroupManagers.StartInstances startInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersStartInstancesRequest content)
throws IOException
Flags the specified instances in the managed instance group to be started. This method increases
the targetSize and decreases the targetStoppedSize of the managed instance group by the number of
instances that you start. The startInstances operation is marked DONE if the startInstances
request is successful. The underlying actions take additional time. You must separately verify
the status of the STARTING action with the listmanagedinstances method. In this request, you can
only specify instances that are stopped. For example, if an instance was previously stopped using
the stopInstances method, it can be started using the startInstances method. If a health check is
attached to the managed instance group, the specified instances will be verified as healthy after
they are started. You can specify a maximum of 1000 instances with this method per request.
Create a request for the method "instanceGroupManagers.startInstances".
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 InstanceGroupManagersStartInstancesRequest- Returns:
- the request
- Throws:
IOException
-
stopInstances
public Compute.InstanceGroupManagers.StopInstances stopInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersStopInstancesRequest content)
throws IOException
Flags the specified instances in the managed instance group to be immediately stopped. You can
only specify instances that are running in this request. This method reduces the targetSize and
increases the targetStoppedSize of the managed instance group by the number of instances that you
stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The
underlying actions take additional time. You must separately verify the status of the STOPPING
action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set,
the group delays stopping the instances until initialDelaySec have passed from
instance.creationTimestamp (that is, when the instance was created). This delay gives your
application time to set itself up and initialize on the instance. If more than initialDelaySec
seconds have passed since instance.creationTimestamp when this method is called, there will be
zero delay. 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 stopped. Stopped instances can be started using the startInstances method. You can
specify a maximum of 1000 instances with this method per request.
Create a request for the method "instanceGroupManagers.stopInstances".
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 InstanceGroupManagersStopInstancesRequest- Returns:
- the request
- Throws:
IOException
-
suspendInstances
public Compute.InstanceGroupManagers.SuspendInstances suspendInstances(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersSuspendInstancesRequest content)
throws IOException
Flags the specified instances in the managed instance group to be immediately suspended. You can
only specify instances that are running in this request. This method reduces the targetSize and
increases the targetSuspendedSize of the managed instance group by the number of instances that
you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is
successful. The underlying actions take additional time. You must separately verify the status of
the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec
field is set, the group delays suspension of the instances until initialDelaySec have passed from
instance.creationTimestamp (that is, when the instance was created). This delay gives your
application time to set itself up and initialize on the instance. If more than initialDelaySec
seconds have passed since instance.creationTimestamp when this method is called, there will be
zero delay. 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 suspended. Suspended instances can be resumed using the resumeInstances method. You
can specify a maximum of 1000 instances with this method per request.
Create a request for the method "instanceGroupManagers.suspendInstances".
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 InstanceGroupManagersSuspendInstancesRequest- Returns:
- the request
- Throws:
IOException
-
updatePerInstanceConfigs
public Compute.InstanceGroupManagers.UpdatePerInstanceConfigs updatePerInstanceConfigs(String project,
String zone,
String instanceGroupManager,
InstanceGroupManagersUpdatePerInstanceConfigsReq content)
throws IOException
Inserts or updates per-instance configurations for the managed instance group.
perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Create a request for the method "instanceGroupManagers.updatePerInstanceConfigs".
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 InstanceGroupManagersUpdatePerInstanceConfigsReq- Returns:
- the request
- Throws:
IOException
Copyright © 2011–2025 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy