patch method

Future<Snapshot> patch(
  1. UpdateSnapshotRequest request,
  2. String name, {
  3. String? $fields,
})

Updates an existing snapshot by updating the fields specified in the update mask.

Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

request - The metadata request object.

Request parameters:

name - Optional. The name of the snapshot. Value must have pattern ^projects/\[^/\]+/snapshots/\[^/\]+$.

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

Completes with a Snapshot.

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

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

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