target.apidocs.com.google.api.services.compute.Compute.RegionInstanceGroupManagers.html Maven / Gradle / Ivy
Compute.RegionInstanceGroupManagers (Compute Engine API v1-rev20200104-1.30.8)
com.google.api.services.compute
Class Compute.RegionInstanceGroupManagers
- java.lang.Object
-
- com.google.api.services.compute.Compute.RegionInstanceGroupManagers
-
-
Nested Class Summary
-
Constructor Summary
Constructors
Constructor and Description
RegionInstanceGroupManagers()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Compute.RegionInstanceGroupManagers.AbandonInstances
abandonInstances(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersAbandonInstancesRequest content)
Flags the specified instances to be immediately removed from the managed instance group.
Compute.RegionInstanceGroupManagers.CreateInstances
createInstances(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersCreateInstancesRequest content)
Creates instances with per-instance configs in this regional managed instance group.
Compute.RegionInstanceGroupManagers.Delete
delete(String project,
String region,
String instanceGroupManager)
Deletes the specified managed instance group and all of the instances in that group.
Compute.RegionInstanceGroupManagers.DeleteInstances
deleteInstances(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersDeleteInstancesRequest content)
Flags the specified instances in the managed instance group to be immediately deleted.
Compute.RegionInstanceGroupManagers.Get
get(String project,
String region,
String instanceGroupManager)
Returns all of the details about the specified managed instance group.
Compute.RegionInstanceGroupManagers.Insert
insert(String project,
String region,
InstanceGroupManager content)
Creates a managed instance group using the information that you specify in the request.
Compute.RegionInstanceGroupManagers.List
list(String project,
String region)
Retrieves the list of managed instance groups that are contained within the specified region.
Compute.RegionInstanceGroupManagers.ListManagedInstances
listManagedInstances(String project,
String region,
String instanceGroupManager)
Lists the instances in the managed instance group and instances that are scheduled to be created.
Compute.RegionInstanceGroupManagers.Patch
patch(String project,
String region,
String instanceGroupManager,
InstanceGroupManager content)
Updates a managed instance group using the information that you specify in the request.
Compute.RegionInstanceGroupManagers.RecreateInstances
recreateInstances(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersRecreateRequest content)
Flags the specified instances in the managed instance group to be immediately recreated.
Compute.RegionInstanceGroupManagers.Resize
resize(String project,
String region,
String instanceGroupManager,
Integer size)
Changes the intended size of the managed instance group.
Compute.RegionInstanceGroupManagers.SetInstanceTemplate
setInstanceTemplate(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersSetTemplateRequest content)
Sets the instance template to use when creating new instances or recreating instances in this
group.
Compute.RegionInstanceGroupManagers.SetTargetPools
setTargetPools(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersSetTargetPoolsRequest content)
Modifies the target pools to which all new instances in this group are assigned.
-
-
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
-
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.
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
-
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.
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 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 "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
-
setInstanceTemplate
public Compute.RegionInstanceGroupManagers.SetInstanceTemplate setInstanceTemplate(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersSetTemplateRequest content)
throws IOException
Sets the instance template to use when creating new instances or recreating instances in this
group. Existing instances are not affected.
Create a request for the method "regionInstanceGroupManagers.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.
region - Name of the region scoping this request.
instanceGroupManager - The name of the managed instance group.
content - the RegionInstanceGroupManagersSetTemplateRequest
- Returns:
- the request
- Throws:
IOException
-
setTargetPools
public Compute.RegionInstanceGroupManagers.SetTargetPools setTargetPools(String project,
String region,
String instanceGroupManager,
RegionInstanceGroupManagersSetTargetPoolsRequest content)
throws IOException
Modifies the target pools to which all new instances in this group are assigned. Existing
instances in the group are not affected.
Create a request for the method "regionInstanceGroupManagers.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.
region - Name of the region scoping this request.
instanceGroupManager - Name of the managed instance group.
content - the RegionInstanceGroupManagersSetTargetPoolsRequest
- Returns:
- the request
- Throws:
IOException
Copyright © 2011–2020 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy