public sealed class RegionInstanceGroupManagersClientImpl : RegionInstanceGroupManagersClient
Reference documentation and code samples for the Compute Engine v1 API class RegionInstanceGroupManagersClientImpl.
RegionInstanceGroupManagers client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The RegionInstanceGroupManagers API.
Constructors
RegionInstanceGroupManagersClientImpl(RegionInstanceGroupManagersClient, RegionInstanceGroupManagersSettings, ILogger)
public RegionInstanceGroupManagersClientImpl(RegionInstanceGroupManagers.RegionInstanceGroupManagersClient grpcClient, RegionInstanceGroupManagersSettings settings, ILogger logger)
Constructs a client wrapper for the RegionInstanceGroupManagers service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | RegionInstanceGroupManagersRegionInstanceGroupManagersClient The underlying gRPC client. |
settings | RegionInstanceGroupManagersSettings The base RegionInstanceGroupManagersSettings 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 |
ApplyUpdatesToInstancesOperationsClient
public override OperationsClient ApplyUpdatesToInstancesOperationsClient { get; }
The long-running operations client for ApplyUpdatesToInstances
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateInstancesOperationsClient
public override OperationsClient CreateInstancesOperationsClient { get; }
The long-running operations client for CreateInstances
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteInstancesOperationsClient
public override OperationsClient DeleteInstancesOperationsClient { get; }
The long-running operations client for DeleteInstances
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteOperationsClient
public override OperationsClient DeleteOperationsClient { get; }
The long-running operations client for Delete
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeletePerInstanceConfigsOperationsClient
public override OperationsClient DeletePerInstanceConfigsOperationsClient { get; }
The long-running operations client for DeletePerInstanceConfigs
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override RegionInstanceGroupManagers.RegionInstanceGroupManagersClient GrpcClient { get; }
The underlying gRPC RegionInstanceGroupManagers client
Property Value | |
---|---|
Type | Description |
RegionInstanceGroupManagersRegionInstanceGroupManagersClient |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }
The long-running operations client for Insert
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
PatchOperationsClient
public override OperationsClient PatchOperationsClient { get; }
The long-running operations client for Patch
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
PatchPerInstanceConfigsOperationsClient
public override OperationsClient PatchPerInstanceConfigsOperationsClient { get; }
The long-running operations client for PatchPerInstanceConfigs
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
RecreateInstancesOperationsClient
public override OperationsClient RecreateInstancesOperationsClient { get; }
The long-running operations client for RecreateInstances
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ResizeOperationsClient
public override OperationsClient ResizeOperationsClient { get; }
The long-running operations client for Resize
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
SetInstanceTemplateOperationsClient
public override OperationsClient SetInstanceTemplateOperationsClient { get; }
The long-running operations client for SetInstanceTemplate
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
SetTargetPoolsOperationsClient
public override OperationsClient SetTargetPoolsOperationsClient { get; }
The long-running operations client for SetTargetPools
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdatePerInstanceConfigsOperationsClient
public override OperationsClient UpdatePerInstanceConfigsOperationsClient { get; }
The long-running operations client for UpdatePerInstanceConfigs
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Parameters | |
---|---|
Name | Description |
request | AbandonInstancesRegionInstanceGroupManagerRequest 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. |
AbandonInstancesAsync(AbandonInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> AbandonInstancesAsync(AbandonInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Parameters | |
---|---|
Name | Description |
request | AbandonInstancesRegionInstanceGroupManagerRequest 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. |
ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Apply updates to selected instances the managed instance group.
Parameters | |
---|---|
Name | Description |
request | ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest 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. |
ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Apply updates to selected instances the managed instance group.
Parameters | |
---|---|
Name | Description |
request | ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest 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. |
CreateInstances(CreateInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> CreateInstances(CreateInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.
Parameters | |
---|---|
Name | Description |
request | CreateInstancesRegionInstanceGroupManagerRequest 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. |
CreateInstancesAsync(CreateInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> CreateInstancesAsync(CreateInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.
Parameters | |
---|---|
Name | Description |
request | CreateInstancesRegionInstanceGroupManagerRequest 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. |
Delete(DeleteRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Deletes the specified managed instance group and all of the instances in that group.
Parameters | |
---|---|
Name | Description |
request | DeleteRegionInstanceGroupManagerRequest 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. |
DeleteAsync(DeleteRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Deletes the specified managed instance group and all of the instances in that group.
Parameters | |
---|---|
Name | Description |
request | DeleteRegionInstanceGroupManagerRequest 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. |
DeleteInstances(DeleteInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> DeleteInstances(DeleteInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Parameters | |
---|---|
Name | Description |
request | DeleteInstancesRegionInstanceGroupManagerRequest 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. |
DeleteInstancesAsync(DeleteInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteInstancesAsync(DeleteInstancesRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Parameters | |
---|---|
Name | Description |
request | DeleteInstancesRegionInstanceGroupManagerRequest 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. |
DeletePerInstanceConfigs(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> DeletePerInstanceConfigs(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Deletes selected per-instance configurations for the managed instance group.
Parameters | |
---|---|
Name | Description |
request | DeletePerInstanceConfigsRegionInstanceGroupManagerRequest 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. |
DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Deletes selected per-instance configurations for the managed instance group.
Parameters | |
---|---|
Name | Description |
request | DeletePerInstanceConfigsRegionInstanceGroupManagerRequest 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. |
Get(GetRegionInstanceGroupManagerRequest, CallSettings)
public override InstanceGroupManager Get(GetRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Returns all of the details about the specified managed instance group.
Parameters | |
---|---|
Name | Description |
request | GetRegionInstanceGroupManagerRequest 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. |
GetAsync(GetRegionInstanceGroupManagerRequest, CallSettings)
public override Task<InstanceGroupManager> GetAsync(GetRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Returns all of the details about the specified managed instance group.
Parameters | |
---|---|
Name | Description |
request | GetRegionInstanceGroupManagerRequest 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. |
Insert(InsertRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> Insert(InsertRegionInstanceGroupManagerRequest 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 regional managed instance group can contain up to 2000 instances.
Parameters | |
---|---|
Name | Description |
request | InsertRegionInstanceGroupManagerRequest 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. |
InsertAsync(InsertRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> InsertAsync(InsertRegionInstanceGroupManagerRequest 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 regional managed instance group can contain up to 2000 instances.
Parameters | |
---|---|
Name | Description |
request | InsertRegionInstanceGroupManagerRequest 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. |
List(ListRegionInstanceGroupManagersRequest, CallSettings)
public override PagedEnumerable<RegionInstanceGroupManagerList, InstanceGroupManager> List(ListRegionInstanceGroupManagersRequest request, CallSettings callSettings = null)
Retrieves the list of managed instance groups that are contained within the specified region.
Parameters | |
---|---|
Name | Description |
request | ListRegionInstanceGroupManagersRequest 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 |
PagedEnumerableRegionInstanceGroupManagerListInstanceGroupManager | A pageable sequence of InstanceGroupManager resources. |
ListAsync(ListRegionInstanceGroupManagersRequest, CallSettings)
public override PagedAsyncEnumerable<RegionInstanceGroupManagerList, InstanceGroupManager> ListAsync(ListRegionInstanceGroupManagersRequest request, CallSettings callSettings = null)
Retrieves the list of managed instance groups that are contained within the specified region.
Parameters | |
---|---|
Name | Description |
request | ListRegionInstanceGroupManagersRequest 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 |
PagedAsyncEnumerableRegionInstanceGroupManagerListInstanceGroupManager | A pageable asynchronous sequence of InstanceGroupManager resources. |
ListErrors(ListErrorsRegionInstanceGroupManagersRequest, CallSettings)
public override PagedEnumerable<RegionInstanceGroupManagersListErrorsResponse, InstanceManagedByIgmError> ListErrors(ListErrorsRegionInstanceGroupManagersRequest request, CallSettings callSettings = null)
Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.
Parameters | |
---|---|
Name | Description |
request | ListErrorsRegionInstanceGroupManagersRequest 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 |
PagedEnumerableRegionInstanceGroupManagersListErrorsResponseInstanceManagedByIgmError | A pageable sequence of InstanceManagedByIgmError resources. |
ListErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest, CallSettings)
public override PagedAsyncEnumerable<RegionInstanceGroupManagersListErrorsResponse, InstanceManagedByIgmError> ListErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest request, CallSettings callSettings = null)
Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.
Parameters | |
---|---|
Name | Description |
request | ListErrorsRegionInstanceGroupManagersRequest 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 |
PagedAsyncEnumerableRegionInstanceGroupManagersListErrorsResponseInstanceManagedByIgmError | A pageable asynchronous sequence of InstanceManagedByIgmError resources. |
ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest, CallSettings)
public override PagedEnumerable<RegionInstanceGroupManagersListInstancesResponse, ManagedInstance> ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest request, CallSettings callSettings = null)
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 in the alpha and beta API and only if the group's listManagedInstancesResults
field is set to PAGINATED
.
Parameters | |
---|---|
Name | Description |
request | ListManagedInstancesRegionInstanceGroupManagersRequest 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 |
PagedEnumerableRegionInstanceGroupManagersListInstancesResponseManagedInstance | A pageable sequence of ManagedInstance resources. |
ListManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest, CallSettings)
public override PagedAsyncEnumerable<RegionInstanceGroupManagersListInstancesResponse, ManagedInstance> ListManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest request, CallSettings callSettings = null)
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 in the alpha and beta API and only if the group's listManagedInstancesResults
field is set to PAGINATED
.
Parameters | |
---|---|
Name | Description |
request | ListManagedInstancesRegionInstanceGroupManagersRequest 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 |
PagedAsyncEnumerableRegionInstanceGroupManagersListInstancesResponseManagedInstance | A pageable asynchronous sequence of ManagedInstance resources. |
ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, CallSettings)
public override PagedEnumerable<RegionInstanceGroupManagersListInstanceConfigsResp, PerInstanceConfig> ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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 | ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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 |
PagedEnumerableRegionInstanceGroupManagersListInstanceConfigsRespPerInstanceConfig | A pageable sequence of PerInstanceConfig resources. |
ListPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, CallSettings)
public override PagedAsyncEnumerable<RegionInstanceGroupManagersListInstanceConfigsResp, PerInstanceConfig> ListPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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 | ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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 |
PagedAsyncEnumerableRegionInstanceGroupManagersListInstanceConfigsRespPerInstanceConfig | A pageable asynchronous sequence of PerInstanceConfig resources. |
Patch(PatchRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> Patch(PatchRegionInstanceGroupManagerRequest 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 | PatchRegionInstanceGroupManagerRequest 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. |
PatchAsync(PatchRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> PatchAsync(PatchRegionInstanceGroupManagerRequest 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 | PatchRegionInstanceGroupManagerRequest 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. |
PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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 | PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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. |
PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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 | PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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. |
RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest 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 | RecreateInstancesRegionInstanceGroupManagerRequest 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. |
RecreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> RecreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest 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 | RecreateInstancesRegionInstanceGroupManagerRequest 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. |
Resize(ResizeRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> Resize(ResizeRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
Parameters | |
---|---|
Name | Description |
request | ResizeRegionInstanceGroupManagerRequest 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. |
ResizeAsync(ResizeRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> ResizeAsync(ResizeRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
Parameters | |
---|---|
Name | Description |
request | ResizeRegionInstanceGroupManagerRequest 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. |
SetInstanceTemplate(SetInstanceTemplateRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> SetInstanceTemplate(SetInstanceTemplateRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
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 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. |
SetInstanceTemplateAsync(SetInstanceTemplateRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetInstanceTemplateAsync(SetInstanceTemplateRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
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 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. |
SetTargetPools(SetTargetPoolsRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> SetTargetPools(SetTargetPoolsRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
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 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. |
SetTargetPoolsAsync(SetTargetPoolsRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetTargetPoolsAsync(SetTargetPoolsRegionInstanceGroupManagerRequest request, CallSettings callSettings = null)
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 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. |
UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, CallSettings)
public override Operation<Operation, Operation> UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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 | UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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. |
UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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 | UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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. |