Compute Engine v1 API - Class InstanceGroupManagers.InstanceGroupManagersBase (3.2.0) 

[BindServiceMethod(typeof(InstanceGroupManagers), "BindService")]
public abstract class InstanceGroupManagers.InstanceGroupManagersBase

Reference documentation and code samples for the Compute Engine v1 API class InstanceGroupManagers.InstanceGroupManagersBase.

Base class for server-side implementations of InstanceGroupManagers

Inheritance

object > InstanceGroupManagers.InstanceGroupManagersBase

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AbandonInstances(AbandonInstancesInstanceGroupManagerRequest, ServerCallContext)

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

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.

Parameters
Name Description
request AbandonInstancesInstanceGroupManagerRequest

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

AggregatedList(AggregatedListInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<InstanceGroupManagerAggregatedList> AggregatedList(AggregatedListInstanceGroupManagersRequest request, ServerCallContext context)

Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListInstanceGroupManagersRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskInstanceGroupManagerAggregatedList

The response to send back to the client (wrapped by a task).

ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest, ServerCallContext)

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

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Parameters
Name Description
request ApplyUpdatesToInstancesInstanceGroupManagerRequest

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(CreateInstancesInstanceGroupManagerRequest, ServerCallContext)

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

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

Parameters
Name Description
request CreateInstancesInstanceGroupManagerRequest

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(DeleteInstanceGroupManagerRequest, ServerCallContext)

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

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.

Parameters
Name Description
request DeleteInstanceGroupManagerRequest

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(DeleteInstancesInstanceGroupManagerRequest, ServerCallContext)

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

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.

Parameters
Name Description
request DeleteInstancesInstanceGroupManagerRequest

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(DeletePerInstanceConfigsInstanceGroupManagerRequest, ServerCallContext)

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

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

Parameters
Name Description
request DeletePerInstanceConfigsInstanceGroupManagerRequest

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(GetInstanceGroupManagerRequest, ServerCallContext)

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

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

Parameters
Name Description
request GetInstanceGroupManagerRequest

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(InsertInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertInstanceGroupManagerRequest 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 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.

Parameters
Name Description
request InsertInstanceGroupManagerRequest

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(ListInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<InstanceGroupManagerList> List(ListInstanceGroupManagersRequest request, ServerCallContext context)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
Name Description
request ListInstanceGroupManagersRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskInstanceGroupManagerList

The response to send back to the client (wrapped by a task).

ListErrors(ListErrorsInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<InstanceGroupManagersListErrorsResponse> ListErrors(ListErrorsInstanceGroupManagersRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListErrorsInstanceGroupManagersRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskInstanceGroupManagersListErrorsResponse

The response to send back to the client (wrapped by a task).

ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<InstanceGroupManagersListManagedInstancesResponse> ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskInstanceGroupManagersListManagedInstancesResponse

The response to send back to the client (wrapped by a task).

ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest, ServerCallContext)

public virtual Task<InstanceGroupManagersListPerInstanceConfigsResp> ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest 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 ListPerInstanceConfigsInstanceGroupManagersRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskInstanceGroupManagersListPerInstanceConfigsResp

The response to send back to the client (wrapped by a task).

Patch(PatchInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> Patch(PatchInstanceGroupManagerRequest 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 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.

Parameters
Name Description
request PatchInstanceGroupManagerRequest

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(PatchPerInstanceConfigsInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest 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 PatchPerInstanceConfigsInstanceGroupManagerRequest

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(RecreateInstancesInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> RecreateInstances(RecreateInstancesInstanceGroupManagerRequest 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 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.

Parameters
Name Description
request RecreateInstancesInstanceGroupManagerRequest

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(ResizeInstanceGroupManagerRequest, ServerCallContext)

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

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.

Parameters
Name Description
request ResizeInstanceGroupManagerRequest

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(ResumeInstancesInstanceGroupManagerRequest, ServerCallContext)

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

Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize 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 the RESUMING action with the listmanagedinstances 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 ResumeInstancesInstanceGroupManagerRequest

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(SetInstanceTemplateInstanceGroupManagerRequest, ServerCallContext)

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

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Parameters
Name Description
request SetInstanceTemplateInstanceGroupManagerRequest

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(SetTargetPoolsInstanceGroupManagerRequest, ServerCallContext)

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

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.

Parameters
Name Description
request SetTargetPoolsInstanceGroupManagerRequest

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(StartInstancesInstanceGroupManagerRequest, ServerCallContext)

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

Flags the specified instances in the managed instance group to be started. This method increases the targetSize 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 the STARTING action with the listmanagedinstances 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 StartInstancesInstanceGroupManagerRequest

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(StopInstancesInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> StopInstances(StopInstancesInstanceGroupManagerRequest 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 the targetSize 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 the STOPPING action with the listmanagedinstances 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 than initialDelaySec seconds have passed since instance.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 StopInstancesInstanceGroupManagerRequest

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(SuspendInstancesInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> SuspendInstances(SuspendInstancesInstanceGroupManagerRequest 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 the targetSize 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 the SUSPENDING action with the listmanagedinstances 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 than initialDelaySec seconds have passed since instance.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 SuspendInstancesInstanceGroupManagerRequest

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(UpdatePerInstanceConfigsInstanceGroupManagerRequest, ServerCallContext)

public virtual Task<Operation> UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest 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 UpdatePerInstanceConfigsInstanceGroupManagerRequest

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