All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.compute.Compute.InstanceGroupManagers.html Maven / Gradle / Ivy

There is a newer version: v1-rev20250107-2.0.0
Show newest version






Compute.InstanceGroupManagers (Compute Engine API alpha-rev20200526-1.30.9)












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 Object
    The "instanceGroupManagers" collection of methods.
    • Constructor Detail

      • InstanceGroupManagers

        public InstanceGroupManagers()
    • 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. 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
      • createInstances

        public Compute.InstanceGroupManagers.CreateInstances createInstances(String project,
                                                                             String zone,
                                                                             String instanceGroupManager,
                                                                             InstanceGroupManagersCreateInstancesRequest content)
                                                                      throws 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:
        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
      • 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. 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:
        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. 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-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. 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 configs defined for the managed instance group. 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. 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
      • recreateInstances

        public Compute.InstanceGroupManagers.RecreateInstances recreateInstances(String project,
                                                                                 String zone,
                                                                                 String instanceGroupManager,
                                                                                 InstanceGroupManagersRecreateInstancesRequest content)
                                                                          throws 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:
        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
      • resizeAdvanced

        public Compute.InstanceGroupManagers.ResizeAdvanced resizeAdvanced(String project,
                                                                           String zone,
                                                                           String instanceGroupManager,
                                                                           InstanceGroupManagersResizeAdvancedRequest content)
                                                                    throws IOException
        Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, 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, creatingWithoutRetries, or deleting actions with the get or 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. Create a request for the method "instanceGroupManagers.resizeAdvanced". 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 InstanceGroupManagersResizeAdvancedRequest
        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
      • update

        public Compute.InstanceGroupManagers.Update update(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 updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. Create a request for the method "instanceGroupManagers.update". 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

Copyright © 2011–2020 Google. All rights reserved.





© 2015 - 2025 Weber Informatics LLC | Privacy Policy