Updates an existing snapshot by updating the fields specified in the update mask. 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
Path parameters
Parameters | |
---|---|
snapshot.name |
Optional. The name of the snapshot. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "snapshot": { "name": string, "topic": string, "expireTime": string, "labels": { string: string, ... } }, "updateMask": string } |
Fields | |
---|---|
snapshot.topic |
Optional. The name of the topic from which this snapshot is retaining messages. |
snapshot.expireTime |
Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
snapshot.labels |
Optional. See Creating and managing labels. An object containing a list of |
updateMask |
Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty. This is a comma-separated list of fully qualified names of fields. Example: |
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.