Compute Engine v1 API - Class RegionInstanceGroupManagers.RegionInstanceGroupManagersBase (3.21.0)

Version latest

• 3.21.0 (latest)
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(RegionInstanceGroupManagers), "BindService")]
public abstract class RegionInstanceGroupManagers.RegionInstanceGroupManagersBase

Reference documentation and code samples for the Compute Engine v1 API class RegionInstanceGroupManagers.RegionInstanceGroupManagersBase.

Base class for server-side implementations of RegionInstanceGroupManagers

Inheritance

object > RegionInstanceGroupManagers.RegionInstanceGroupManagersBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 thetargetSize of the managed instance group by the number of instances that you abandon. This operation is marked asDONE 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 thelistmanagedinstances 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.

Parameters
Name	Description
request	AbandonInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

Apply updates to selected instances the managed instance group.

Parameters
Name	Description
request	ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateInstances(CreateInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> CreateInstances(CreateInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 thecreating or actions with the listmanagedinstances method.

Parameters
Name	Description
request	CreateInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

Delete(DeleteRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> Delete(DeleteRegionInstanceGroupManagerRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteInstances(DeleteInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> DeleteInstances(DeleteInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 thetargetSize 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 thedeleting action with thelistmanagedinstances 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.

Parameters
Name	Description
request	DeleteInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeletePerInstanceConfigs(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> DeletePerInstanceConfigs(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeletePerInstanceConfigsRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

Get(GetRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<InstanceGroupManager> Get(GetRegionInstanceGroupManagerRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstanceGroupManager	The response to send back to the client (wrapped by a task).

Insert(InsertRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 thelistmanagedinstances method.

A regional managed instance group can contain up to 2000 instances.

Parameters
Name	Description
request	InsertRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

List(ListRegionInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<RegionInstanceGroupManagerList> List(ListRegionInstanceGroupManagersRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListRegionInstanceGroupManagersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRegionInstanceGroupManagerList	The response to send back to the client (wrapped by a task).

ListErrors(ListErrorsRegionInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<RegionInstanceGroupManagersListErrorsResponse> ListErrors(ListErrorsRegionInstanceGroupManagersRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListErrorsRegionInstanceGroupManagersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRegionInstanceGroupManagersListErrorsResponse	The response to send back to the client (wrapped by a task).

ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<RegionInstanceGroupManagersListInstancesResponse> ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ListManagedInstancesRegionInstanceGroupManagersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRegionInstanceGroupManagersListInstancesResponse	The response to send back to the client (wrapped by a task).

ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<RegionInstanceGroupManagersListInstanceConfigsResp> ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListPerInstanceConfigsRegionInstanceGroupManagersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRegionInstanceGroupManagersListInstanceConfigsResp	The response to send back to the client (wrapped by a task).

Patch(PatchRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> Patch(PatchRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 supportsPATCH semantics and uses theJSON 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, seeUpdating instances in a MIG.

Parameters
Name	Description
request	PatchRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	PatchPerInstanceConfigsRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 itscurrentAction 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.

Parameters
Name	Description
request	RecreateInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

Resize(ResizeRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> Resize(ResizeRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 theresize request is successful. The underlying actions take additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances 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.

Parameters
Name	Description
request	ResizeRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ResumeInstances(ResumeInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> ResumeInstances(ResumeInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

Flags the specified instances in the managed instance group to be resumed. This method increases thetargetSize 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 theRESUMING action with thelistmanagedinstances 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.

Parameters
Name	Description
request	ResumeInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SetInstanceTemplate(SetInstanceTemplateRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> SetInstanceTemplate(SetInstanceTemplateRegionInstanceGroupManagerRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	SetInstanceTemplateRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SetTargetPools(SetTargetPoolsRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> SetTargetPools(SetTargetPoolsRegionInstanceGroupManagerRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	SetTargetPoolsRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StartInstances(StartInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> StartInstances(StartInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

Flags the specified instances in the managed instance group to be started. This method increases thetargetSize 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 theSTARTING action with thelistmanagedinstances 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.

Parameters
Name	Description
request	StartInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StopInstances(StopInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> StopInstances(StopInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 thetargetSize 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 theSTOPPING action with thelistmanagedinstances 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 thaninitialDelaySec seconds have passed sinceinstance.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.

Parameters
Name	Description
request	StopInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SuspendInstances(SuspendInstancesRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> SuspendInstances(SuspendInstancesRegionInstanceGroupManagerRequest request, ServerCallContext context)

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 thetargetSize 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 theSUSPENDING action with thelistmanagedinstances 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 thaninitialDelaySec seconds have passed sinceinstance.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.

Parameters
Name	Description
request	SuspendInstancesRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).