get method

Future<Snapshot> get(
  1. String snapshot, {
  2. String? $fields,
})

Gets the configuration details of a snapshot.

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 parameters:

snapshot - Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}. 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> get(
  core.String snapshot, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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