list method

Future<ListTopicSnapshotsResponse> list(String topic, { int? pageSize, String? pageToken, String? $fields, })

Lists the names of the snapshots on this topic.

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:

topic - Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}. Value must have pattern ^projects/\[^/\]+/topics/\[^/\]+$.

pageSize - Optional. Maximum number of snapshot names to return.

pageToken - Optional. The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots 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 ListTopicSnapshotsResponse.

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<ListTopicSnapshotsResponse> list(
  core.String topic, {
  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('$topic') + '/snapshots';

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