list method

Future<ListSnapshotsResponse> list(
  1. String project, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists the existing snapshots.

Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) 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:

project - Required. The name of the project in which to list snapshots. Format is projects/{project-id}. Value must have pattern ^projects/\[^/\]+$.

pageSize - Optional. Maximum number of snapshots to return.

pageToken - Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

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

Completes with a ListSnapshotsResponse.

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<ListSnapshotsResponse> list(
  core.String project, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

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

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