Method: projects.subscriptions.seek

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.

ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

HTTP request

POST https://pubsub.googleapis.com/v1/{subscription}:seek

Path parameters

Parameters
subscription

string

The subscription to affect.

Request body

The request body contains data with the following structure:

JSON representation
{

  // Union field target can be only one of the following:
  "time": string,
  "snapshot": string
  // End of list of possible types for union field target.
}
Fields

Union field target.

target can be only one of the following:

time

string (Timestamp format)

The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of messageRetentionDuration and retainAckedMessages). For example, if time corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

snapshot

string

The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is projects/{project}/snapshots/{snap}.

Response body

If successful, the response body will be empty.

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 Auth Guide.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Pub/Sub