update method

Future<Operation> update(Instance request, String project, String zone, String instance, { String? minimalAction, String? mostDisruptiveAllowedAction, String? requestId, String? $fields, })

Updates an instance only if the necessary resources are available.

This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

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\])?)).

zone - The name of the zone for this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?.

instance - Name of the instance resource to update. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

minimalAction - Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Possible string values are:

• "INVALID"
• "NO_EFFECT" : No changes can be made to the instance.
• "REFRESH" : The instance will not restart.
• "RESTART" : The instance will restart, potentially on a different host.

mostDisruptiveAllowedAction - Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Possible string values are:

• "INVALID"
• "NO_EFFECT" : No changes can be made to the instance.
• "REFRESH" : The instance will not restart.
• "RESTART" : The instance will restart, potentially on a different host.

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> update(
  Instance request,
  core.String project,
  core.String zone,
  core.String instance, {
  core.String? minimalAction,
  core.String? mostDisruptiveAllowedAction,
  core.String? requestId,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'minimalAction': ?minimalAction == null ? null : [minimalAction],
    'mostDisruptiveAllowedAction': ?mostDisruptiveAllowedAction == null
        ? null
        : [mostDisruptiveAllowedAction],
    'requestId': ?requestId == null ? null : [requestId],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'projects/' +
      commons.escapeVariable('$project') +
      '/zones/' +
      commons.escapeVariable('$zone') +
      '/instances/' +
      commons.escapeVariable('$instance');

  final response_ = await _requester.request(
    url_,
    'PUT',
    body: body_,
    queryParams: queryParams_,
  );
  return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}