patch method

Future<GoogleLongrunningOperation> patch(
  1. BackupChannel request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Update a BackupChannel.

request - The metadata request object.

Request parameters:

name - Identifier. The fully qualified name of the BackupChannel. projects / * /locations / * /backupChannels / * Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/backupChannels/\[^/\]+$.

updateMask - Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the backup_channel provided with this request. Field names are relative to the root of the resource (e.g., description, labels, etc.) If no update_mask is provided, all fields in backup_channel will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_channel are ignored and are not used to update the target BackupChannel.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleLongrunningOperation.

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<GoogleLongrunningOperation> patch(
  BackupChannel 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_ = 'v1/' + core.Uri.encodeFull('$name');

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