abandonInstances method
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.
request - The metadata request object.
Request parameters:
project - Project ID for this request.
Value must have pattern
(?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).
region - Name of the region scoping this request.
instanceGroupManager - Name of the managed instance group.
requestId - An optional request ID to identify requests. Specify a
unique request ID so that if you must retry your request, the server will
know to ignore the request if it has already been completed. For example,
consider a situation where you make an initial request and the request
times out. If you make the request again with the same request ID, the
server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments. The request ID must be a
valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).
$fields - Selector specifying which fields to include in a partial
response.
Completes with a Operation.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<Operation> abandonInstances(
RegionInstanceGroupManagersAbandonInstancesRequest request,
core.String project,
core.String region,
core.String instanceGroupManager, {
core.String? requestId,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (requestId != null) 'requestId': [requestId],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'projects/' +
commons.escapeVariable('$project') +
'/regions/' +
commons.escapeVariable('$region') +
'/instanceGroupManagers/' +
commons.escapeVariable('$instanceGroupManager') +
'/abandonInstances';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}