Compute Engine v1 API - Class InstanceGroupManagersClientImpl (3.1.0) 

public sealed class InstanceGroupManagersClientImpl : InstanceGroupManagersClient

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

InstanceGroupManagers client wrapper implementation, for convenient use.

Inheritance

object > InstanceGroupManagersClient > InstanceGroupManagersClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The InstanceGroupManagers API.

Constructors

InstanceGroupManagersClientImpl(InstanceGroupManagersClient, InstanceGroupManagersSettings, ILogger)

public InstanceGroupManagersClientImpl(InstanceGroupManagers.InstanceGroupManagersClient grpcClient, InstanceGroupManagersSettings settings, ILogger logger)

Constructs a client wrapper for the InstanceGroupManagers service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient InstanceGroupManagersInstanceGroupManagersClient

The underlying gRPC client.
settings InstanceGroupManagersSettings

The base InstanceGroupManagersSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

AbandonInstancesOperationsClient

public override OperationsClient AbandonInstancesOperationsClient { get; }

The long-running operations client for AbandonInstances.

Property Value
Type Description
OperationsClient
Overrides

ApplyUpdatesToInstancesOperationsClient

public override OperationsClient ApplyUpdatesToInstancesOperationsClient { get; }

The long-running operations client for ApplyUpdatesToInstances.

Property Value
Type Description
OperationsClient
Overrides

CreateInstancesOperationsClient

public override OperationsClient CreateInstancesOperationsClient { get; }

The long-running operations client for CreateInstances.

Property Value
Type Description
OperationsClient
Overrides

DeleteInstancesOperationsClient

public override OperationsClient DeleteInstancesOperationsClient { get; }

The long-running operations client for DeleteInstances.

Property Value
Type Description
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

DeletePerInstanceConfigsOperationsClient

public override OperationsClient DeletePerInstanceConfigsOperationsClient { get; }

The long-running operations client for DeletePerInstanceConfigs.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override InstanceGroupManagers.InstanceGroupManagersClient GrpcClient { get; }

The underlying gRPC InstanceGroupManagers client

Property Value
Type Description
InstanceGroupManagersInstanceGroupManagersClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

PatchPerInstanceConfigsOperationsClient

public override OperationsClient PatchPerInstanceConfigsOperationsClient { get; }

The long-running operations client for PatchPerInstanceConfigs.

Property Value
Type Description
OperationsClient
Overrides

RecreateInstancesOperationsClient

public override OperationsClient RecreateInstancesOperationsClient { get; }

The long-running operations client for RecreateInstances.

Property Value
Type Description
OperationsClient
Overrides

ResizeOperationsClient

public override OperationsClient ResizeOperationsClient { get; }

The long-running operations client for Resize.

Property Value
Type Description
OperationsClient
Overrides

SetInstanceTemplateOperationsClient

public override OperationsClient SetInstanceTemplateOperationsClient { get; }

The long-running operations client for SetInstanceTemplate.

Property Value
Type Description
OperationsClient
Overrides

SetTargetPoolsOperationsClient

public override OperationsClient SetTargetPoolsOperationsClient { get; }

The long-running operations client for SetTargetPools.

Property Value
Type Description
OperationsClient
Overrides

UpdatePerInstanceConfigsOperationsClient

public override OperationsClient UpdatePerInstanceConfigsOperationsClient { get; }

The long-running operations client for UpdatePerInstanceConfigs.

Property Value
Type Description
OperationsClient
Overrides

Methods

AbandonInstances(AbandonInstancesInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> AbandonInstances(AbandonInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

AbandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AbandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

AggregatedList(AggregatedListInstanceGroupManagersRequest, CallSettings)

public override PagedEnumerable<InstanceGroupManagerAggregatedList, KeyValuePair<string, InstanceGroupManagersScopedList>> AggregatedList(AggregatedListInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableInstanceGroupManagerAggregatedListKeyValuePairstringInstanceGroupManagersScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Overrides

AggregatedListAsync(AggregatedListInstanceGroupManagersRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupManagerAggregatedList, KeyValuePair<string, InstanceGroupManagersScopedList>> AggregatedListAsync(AggregatedListInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableInstanceGroupManagerAggregatedListKeyValuePairstringInstanceGroupManagersScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Overrides

ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

CreateInstances(CreateInstancesInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> CreateInstances(CreateInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

CreateInstancesAsync(CreateInstancesInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> CreateInstancesAsync(CreateInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Delete(DeleteInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteAsync(DeleteInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

DeleteInstances(DeleteInstancesInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> DeleteInstances(DeleteInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

DeletePerInstanceConfigs(DeletePerInstanceConfigsInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> DeletePerInstanceConfigs(DeletePerInstanceConfigsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeletePerInstanceConfigsInstanceGroupManagerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeletePerInstanceConfigsInstanceGroupManagerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Get(GetInstanceGroupManagerRequest, CallSettings)

public override InstanceGroupManager Get(GetInstanceGroupManagerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetInstanceGroupManagerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
InstanceGroupManager

The RPC response.
Overrides

GetAsync(GetInstanceGroupManagerRequest, CallSettings)

public override Task<InstanceGroupManager> GetAsync(GetInstanceGroupManagerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetInstanceGroupManagerRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskInstanceGroupManager

A Task containing the RPC response.
Overrides

Insert(InsertInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

InsertAsync(InsertInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

List(ListInstanceGroupManagersRequest, CallSettings)

public override PagedEnumerable<InstanceGroupManagerList, InstanceGroupManager> List(ListInstanceGroupManagersRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListInstanceGroupManagersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableInstanceGroupManagerListInstanceGroupManager

A pageable sequence of InstanceGroupManager resources.
Overrides

ListAsync(ListInstanceGroupManagersRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupManagerList, InstanceGroupManager> ListAsync(ListInstanceGroupManagersRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListInstanceGroupManagersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableInstanceGroupManagerListInstanceGroupManager

A pageable asynchronous sequence of InstanceGroupManager resources.
Overrides

ListErrors(ListErrorsInstanceGroupManagersRequest, CallSettings)

public override PagedEnumerable<InstanceGroupManagersListErrorsResponse, InstanceManagedByIgmError> ListErrors(ListErrorsInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableInstanceGroupManagersListErrorsResponseInstanceManagedByIgmError

A pageable sequence of InstanceManagedByIgmError resources.
Overrides

ListErrorsAsync(ListErrorsInstanceGroupManagersRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupManagersListErrorsResponse, InstanceManagedByIgmError> ListErrorsAsync(ListErrorsInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableInstanceGroupManagersListErrorsResponseInstanceManagedByIgmError

A pageable asynchronous sequence of InstanceManagedByIgmError resources.
Overrides

ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest, CallSettings)

public override PagedEnumerable<InstanceGroupManagersListManagedInstancesResponse, ManagedInstance> ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableInstanceGroupManagersListManagedInstancesResponseManagedInstance

A pageable sequence of ManagedInstance resources.
Overrides

ListManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupManagersListManagedInstancesResponse, ManagedInstance> ListManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableInstanceGroupManagersListManagedInstancesResponseManagedInstance

A pageable asynchronous sequence of ManagedInstance resources.
Overrides

ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest, CallSettings)

public override PagedEnumerable<InstanceGroupManagersListPerInstanceConfigsResp, PerInstanceConfig> ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableInstanceGroupManagersListPerInstanceConfigsRespPerInstanceConfig

A pageable sequence of PerInstanceConfig resources.
Overrides

ListPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupManagersListPerInstanceConfigsResp, PerInstanceConfig> ListPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableInstanceGroupManagersListPerInstanceConfigsRespPerInstanceConfig

A pageable asynchronous sequence of PerInstanceConfig resources.
Overrides

Patch(PatchInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

PatchAsync(PatchInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchAsync(PatchInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

RecreateInstances(RecreateInstancesInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> RecreateInstances(RecreateInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

RecreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RecreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Resize(ResizeInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> Resize(ResizeInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

ResizeAsync(ResizeInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> ResizeAsync(ResizeInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

SetInstanceTemplate(SetInstanceTemplateInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> SetInstanceTemplate(SetInstanceTemplateInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

SetInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

SetTargetPools(SetTargetPoolsInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> SetTargetPools(SetTargetPoolsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

SetTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest, CallSettings)

public override Operation<Operation, Operation> UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides