- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists the existing snapshots. Snapshots are used in [subscriptions.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.
HTTP request
Path parameters
Parameters | |
---|---|
project |
Required. The name of the project in which to list snapshots. Format is |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Maximum number of snapshots to return. |
pageToken |
Optional. The value returned by the last |
Request body
The request body must be empty.
Response body
Response for the snapshots.list
method.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"snapshots": [
{
object ( |
Fields | |
---|---|
snapshots[] |
Optional. The resulting snapshots. |
nextPageToken |
Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.