Class RegionInstanceGroupManagersResource

The "regionInstanceGroupManagers" collection of methods.

Inheritance

object

RegionInstanceGroupManagersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Compute.v1

Assembly: Google.Apis.Compute.v1.dll

Syntax

public class RegionInstanceGroupManagersResource

Constructors

RegionInstanceGroupManagersResource(IClientService)

Constructs a new resource.

Declaration

public RegionInstanceGroupManagersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AbandonInstances(RegionInstanceGroupManagersAbandonInstancesRequest, string, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.AbandonInstancesRequest AbandonInstances(RegionInstanceGroupManagersAbandonInstancesRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersAbandonInstancesRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group.

Returns

Type	Description
RegionInstanceGroupManagersResource.AbandonInstancesRequest

ApplyUpdatesToInstances(RegionInstanceGroupManagersApplyUpdatesRequest, string, string, string)

Apply updates to selected instances the managed instance group.

Declaration

public virtual RegionInstanceGroupManagersResource.ApplyUpdatesToInstancesRequest ApplyUpdatesToInstances(RegionInstanceGroupManagersApplyUpdatesRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersApplyUpdatesRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request, should conform to RFC1035.
string	instanceGroupManager	The name of the managed instance group, should conform to RFC1035.

Returns

Type	Description
RegionInstanceGroupManagersResource.ApplyUpdatesToInstancesRequest

CreateInstances(RegionInstanceGroupManagersCreateInstancesRequest, string, string, string)

Creates instances with per-instance configurations 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.

Declaration

public virtual RegionInstanceGroupManagersResource.CreateInstancesRequest CreateInstances(RegionInstanceGroupManagersCreateInstancesRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersCreateInstancesRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	The name of the region where the managed instance group is located. It should conform to RFC1035.
string	instanceGroupManager	The name of the managed instance group. It should conform to RFC1035.

Returns

Type	Description
RegionInstanceGroupManagersResource.CreateInstancesRequest

Delete(string, string, string)

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

Declaration

public virtual RegionInstanceGroupManagersResource.DeleteRequest Delete(string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group to delete.

Returns

Type	Description
RegionInstanceGroupManagersResource.DeleteRequest

DeleteInstances(RegionInstanceGroupManagersDeleteInstancesRequest, string, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.DeleteInstancesRequest DeleteInstances(RegionInstanceGroupManagersDeleteInstancesRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersDeleteInstancesRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group.

Returns

Type	Description
RegionInstanceGroupManagersResource.DeleteInstancesRequest

DeletePerInstanceConfigs(RegionInstanceGroupManagerDeleteInstanceConfigReq, string, string, string)

Deletes selected per-instance configurations for the managed instance group.

Declaration

public virtual RegionInstanceGroupManagersResource.DeletePerInstanceConfigsRequest DeletePerInstanceConfigs(RegionInstanceGroupManagerDeleteInstanceConfigReq body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagerDeleteInstanceConfigReq	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request, should conform to RFC1035.
string	instanceGroupManager	The name of the managed instance group. It should conform to RFC1035.

Returns

Type	Description
RegionInstanceGroupManagersResource.DeletePerInstanceConfigsRequest

Get(string, string, string)

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

Declaration

public virtual RegionInstanceGroupManagersResource.GetRequest Get(string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group to return.

Returns

Type	Description
RegionInstanceGroupManagersResource.GetRequest

Insert(InstanceGroupManager, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.InsertRequest Insert(InstanceGroupManager body, string project, string region)

Parameters

Type	Name	Description
InstanceGroupManager	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.

Returns

Type	Description
RegionInstanceGroupManagersResource.InsertRequest

List(string, string)

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

Declaration

public virtual RegionInstanceGroupManagersResource.ListRequest List(string project, string region)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request.

Returns

Type	Description
RegionInstanceGroupManagersResource.ListRequest

ListErrors(string, string, string)

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

Declaration

public virtual RegionInstanceGroupManagersResource.ListErrorsRequest ListErrors(string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request. This should conform to RFC1035.
string	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?)|1-9{0,19}.

Returns

Type	Description
RegionInstanceGroupManagersResource.ListErrorsRequest

ListManagedInstances(string, string, string)

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. The pageToken query parameter is supported only if the group's listManagedInstancesResults field is set to PAGINATED.

Declaration

public virtual RegionInstanceGroupManagersResource.ListManagedInstancesRequest ListManagedInstances(string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	The name of the managed instance group.

Returns

Type	Description
RegionInstanceGroupManagersResource.ListManagedInstancesRequest

ListPerInstanceConfigs(string, string, string)

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

Declaration

public virtual RegionInstanceGroupManagersResource.ListPerInstanceConfigsRequest ListPerInstanceConfigs(string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request, should conform to RFC1035.
string	instanceGroupManager	The name of the managed instance group. It should conform to RFC1035.

Returns

Type	Description
RegionInstanceGroupManagersResource.ListPerInstanceConfigsRequest

Patch(InstanceGroupManager, string, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.PatchRequest Patch(InstanceGroupManager body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
InstanceGroupManager	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	The name of the instance group manager.

Returns

Type	Description
RegionInstanceGroupManagersResource.PatchRequest

PatchPerInstanceConfigs(RegionInstanceGroupManagerPatchInstanceConfigReq, string, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.PatchPerInstanceConfigsRequest PatchPerInstanceConfigs(RegionInstanceGroupManagerPatchInstanceConfigReq body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagerPatchInstanceConfigReq	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request, should conform to RFC1035.
string	instanceGroupManager	The name of the managed instance group. It should conform to RFC1035.

Returns

Type	Description
RegionInstanceGroupManagersResource.PatchPerInstanceConfigsRequest

RecreateInstances(RegionInstanceGroupManagersRecreateRequest, string, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.RecreateInstancesRequest RecreateInstances(RegionInstanceGroupManagersRecreateRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersRecreateRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group.

Returns

Type	Description
RegionInstanceGroupManagersResource.RecreateInstancesRequest

Resize(string, string, string, int)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.ResizeRequest Resize(string project, string region, string instanceGroupManager, int size)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group.
int	size	Number of instances that should exist in this instance group manager.

Returns

Type	Description
RegionInstanceGroupManagersResource.ResizeRequest

SetInstanceTemplate(RegionInstanceGroupManagersSetTemplateRequest, string, string, string)

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Declaration

public virtual RegionInstanceGroupManagersResource.SetInstanceTemplateRequest SetInstanceTemplate(RegionInstanceGroupManagersSetTemplateRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersSetTemplateRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	The name of the managed instance group.

Returns

Type	Description
RegionInstanceGroupManagersResource.SetInstanceTemplateRequest

SetTargetPools(RegionInstanceGroupManagersSetTargetPoolsRequest, string, string, string)

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Declaration

public virtual RegionInstanceGroupManagersResource.SetTargetPoolsRequest SetTargetPools(RegionInstanceGroupManagersSetTargetPoolsRequest body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagersSetTargetPoolsRequest	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request.
string	instanceGroupManager	Name of the managed instance group.

Returns

Type	Description
RegionInstanceGroupManagersResource.SetTargetPoolsRequest

UpdatePerInstanceConfigs(RegionInstanceGroupManagerUpdateInstanceConfigReq, string, string, string)

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.

Declaration

public virtual RegionInstanceGroupManagersResource.UpdatePerInstanceConfigsRequest UpdatePerInstanceConfigs(RegionInstanceGroupManagerUpdateInstanceConfigReq body, string project, string region, string instanceGroupManager)

Parameters

Type	Name	Description
RegionInstanceGroupManagerUpdateInstanceConfigReq	body	The body of the request.
string	project	Project ID for this request.
string	region	Name of the region scoping this request, should conform to RFC1035.
string	instanceGroupManager	The name of the managed instance group. It should conform to RFC1035.

Returns

Type	Description
RegionInstanceGroupManagersResource.UpdatePerInstanceConfigsRequest