Cloud Pub/Sub API . projects . topics . snapshots

Instance Methods

close()

Close httplib2 connections.

list(topic, pageSize=None, pageToken=None, x__xgafv=None)

Lists the names of the snapshots on this topic. 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.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(topic, pageSize=None, pageToken=None, x__xgafv=None)
Lists the names of the snapshots on this topic. 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.

Args:
  topic: string, Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`. (required)
  pageSize: integer, Optional. Maximum number of snapshot names to return.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `ListTopicSnapshots` method.
  "nextPageToken": "A String", # Optional. If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots.
  "snapshots": [ # Optional. The names of the snapshots that match the request.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.