Console
    Start free

    Method: projects.snapshots.list

    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

    string

    Required. The name of the project in which to list snapshots. Format is projects/{project-id} .

    Query parameters

    Parameters
    pageSize

    integer

    Optional. Maximum number of snapshots to return.
    pageToken

    string

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

    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 (  Snapshot 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    snapshots[]

    object ( Snapshot )

    Optional. The resulting snapshots.
    nextPageToken

    string

    Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new ListSnapshotsRequest .

    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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: