partialUpdateInstance method

Future<Operation> partialUpdateInstance(Instance request, String name, { String? updateMask, String? $fields, })

Partially updates an instance within a project.

This method can modify all fields of an Instance and is the preferred way to update an Instance.

request - The metadata request object.

Request parameters:

name - The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9]. Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+$.

updateMask - Required. The subset of Instance fields which should be replaced. Must be explicitly set.

$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> partialUpdateInstance(
  Instance request,
  core.String name, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name');

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