All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

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

    





Compute.RegionInstanceGroupManagers (Compute Engine API beta-rev20220312-1.32.1)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.compute
    

    Class Compute.RegionInstanceGroupManagers
    

    

    

      

    • java.lang.Object
      • 

    • 

        

      • com.google.api.services.compute.Compute.RegionInstanceGroupManagers
        • 

      

      • 

    

    

      

    • 

      

      Enclosing class:
      

      Compute
      

      

      

      

      public class Compute.RegionInstanceGroupManagers
extends Object
      

      The "regionInstanceGroupManagers" collection of methods.
      

      • 

    

    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          RegionInstanceGroupManagers
          

          public RegionInstanceGroupManagers()
          

          • 

        

        • 

      


        

      • 



        Method Detail
        




          

        • 

          abandonInstances
          

          public Compute.RegionInstanceGroupManagers.AbandonInstances abandonInstances(String project,
                                                                             String region,
                                                                             String instanceGroupManager,
                                                                             RegionInstanceGroupManagersAbandonInstancesRequest content)
                                                                      throws IOException
          

          Flags the specified instances to be immediately 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 "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - Name of the managed instance group.
          

          content - the RegionInstanceGroupManagersAbandonInstancesRequest
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        








          

        • 

          createInstances
          

          public Compute.RegionInstanceGroupManagers.CreateInstances createInstances(String project,
                                                                           String region,
                                                                           String instanceGroupManager,
                                                                           RegionInstanceGroupManagersCreateInstancesRequest content)
                                                                    throws IOException
          

          Creates instances with per-instance configs in this regional 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 "regionInstanceGroupManagers.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.
          

          region - The name of the region 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 RegionInstanceGroupManagersCreateInstancesRequest
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          delete
          

          public Compute.RegionInstanceGroupManagers.Delete delete(String project,
                                                         String region,
                                                         String instanceGroupManager)
                                                  throws IOException
          

          Deletes the specified managed instance group and all of the instances in that group.

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - Name of the managed instance group to delete.
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          deleteInstances
          

          public Compute.RegionInstanceGroupManagers.DeleteInstances deleteInstances(String project,
                                                                           String region,
                                                                           String instanceGroupManager,
                                                                           RegionInstanceGroupManagersDeleteInstancesRequest content)
                                                                    throws IOException
          

          Flags the specified instances in the managed instance group to be immediately deleted. 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. The
 deleteInstances operation is marked DONE if the deleteInstances request is successful. The
 underlying actions take additional time. 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 "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - Name of the managed instance group.
          

          content - the RegionInstanceGroupManagersDeleteInstancesRequest
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        








          

        • 

          get
          

          public Compute.RegionInstanceGroupManagers.Get get(String project,
                                                   String region,
                                                   String instanceGroupManager)
                                            throws IOException
          

          Returns all of the details about the specified managed instance group.

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - Name of the managed instance group to return.
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          insert
          

          public Compute.RegionInstanceGroupManagers.Insert insert(String project,
                                                         String region,
                                                         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 regional managed instance group can contain up to 2000 instances.

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          content - the InstanceGroupManager
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          list
          

          public Compute.RegionInstanceGroupManagers.List list(String project,
                                                     String region)
                                              throws IOException
          

          Retrieves the list of managed instance groups that are contained within the specified region.

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          listErrors
          

          public Compute.RegionInstanceGroupManagers.ListErrors listErrors(String project,
                                                                 String region,
                                                                 String instanceGroupManager)
                                                          throws IOException
          

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

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request. This 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.RegionInstanceGroupManagers.ListManagedInstances listManagedInstances(String project,
                                                                                     String region,
                                                                                     String instanceGroupManager)
                                                                              throws IOException
          

          Lists the instances in the managed instance group and instances that are scheduled to be created.
 The list includes any current actions that the group has scheduled for its instances. The orderBy
 query parameter is not supported.

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - The name of the managed instance group.
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          listPerInstanceConfigs
          

          public Compute.RegionInstanceGroupManagers.ListPerInstanceConfigs listPerInstanceConfigs(String project,
                                                                                         String region,
                                                                                         String instanceGroupManager)
                                                                                  throws IOException
          

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

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request, 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.RegionInstanceGroupManagers.Patch patch(String project,
                                                       String region,
                                                       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 "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - The name of the instance group manager.
          

          content - the InstanceGroupManager
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        








          

        • 

          recreateInstances
          

          public Compute.RegionInstanceGroupManagers.RecreateInstances recreateInstances(String project,
                                                                               String region,
                                                                               String instanceGroupManager,
                                                                               RegionInstanceGroupManagersRecreateRequest 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 "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - Name of the managed instance group.
          

          content - the RegionInstanceGroupManagersRecreateRequest
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          resize
          

          public Compute.RegionInstanceGroupManagers.Resize resize(String project,
                                                         String region,
                                                         String instanceGroupManager,
                                                         Integer size)
                                                  throws IOException
          

          Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is
 successful. The underlying actions take additional time. You must separately verify the status of
 the creating or deleting actions 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.

 Create a request for the method "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - Name of the managed instance group.
          

          size - Number of instances that should exist in this instance group manager.
    [minimum: 0]
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          resizeAdvanced
          

          public Compute.RegionInstanceGroupManagers.ResizeAdvanced resizeAdvanced(String project,
                                                                         String region,
                                                                         String instanceGroupManager,
                                                                         RegionInstanceGroupManagersResizeAdvancedRequest content)
                                                                  throws IOException
          

          Resizes the regional 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, the
 group creates new instances using the current instance template. If you decrease the size, the
 group deletes one or more instances. The resize operation is marked DONE if the resize request is
 successful. The underlying actions take additional time. You must separately verify the status of
 the creating 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 "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
          

          instanceGroupManager - The name of the managed instance group. It must be a string that meets the requirements in RFC1035.
          

          content - the RegionInstanceGroupManagersResizeAdvancedRequest
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        




















          

        • 

          update
          

          public Compute.RegionInstanceGroupManagers.Update update(String project,
                                                         String region,
                                                         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. 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 "regionInstanceGroupManagers.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.
          

          region - Name of the region scoping this request.
          

          instanceGroupManager - The name of the instance group manager.
          

          content - the InstanceGroupManager
          

          Returns:
          

          the request
          

          Throws:
          

          IOException
          

          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2022 Google. All rights reserved.




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy