Method: projects.snapshots.get

Stay organized with collections Save and categorize content based on your preferences.

Gets the configuration details of a snapshot. Snapshots are used in subscriptions.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.

HTTP request

GET https://pubsub.googleapis.com/v1/{snapshot}

Path parameters

Parameters
snapshot

string

Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Snapshot.

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.