public sealed class Snapshot : IMessage<Snapshot>, IEquatable<Snapshot>, IDeepCloneable<Snapshot>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Pub/Sub v1 API class Snapshot.
A snapshot resource. Snapshots are used in
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.
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 7 days - (age of oldest unacked message in the subscription).
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe webpage provides reference documentation for the Cloud Pub/Sub v1 API class \u003ccode\u003eSnapshot\u003c/code\u003e, which is used to manage message acknowledgments in bulk, allowing users to set the acknowledgment state of messages in an existing subscription to a captured state.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the API is 3.23.0, and it includes documentation for versions spanning from 3.23.0 to 2.3.0, with the specific focus of this webpage on the 3.6.0 version.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSnapshot\u003c/code\u003e class implements interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and has inherited members such as \u003ccode\u003eGetHashCode\u003c/code\u003e, \u003ccode\u003eGetType\u003c/code\u003e, and \u003ccode\u003eToString\u003c/code\u003e from the \u003ccode\u003eobject\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the Snapshot class include \u003ccode\u003eExpireTime\u003c/code\u003e, which indicates the snapshot's expiration time, \u003ccode\u003eLabels\u003c/code\u003e for managing labels, and \u003ccode\u003eName\u003c/code\u003e, \u003ccode\u003eSnapshotName\u003c/code\u003e, \u003ccode\u003eTopic\u003c/code\u003e, and \u003ccode\u003eTopicAsTopicName\u003c/code\u003e for managing the snapshot and associated topic names.\u003c/p\u003e\n"],["\u003cp\u003eSnapshots are created with an expiration time determined by the age of the oldest unacknowledged message in the source subscription, with the rule that they expire no later than 7 days from creation and no less than 1 hour after creation.\u003c/p\u003e\n"]]],[],null,[]]
