public sealed class Snapshot : IMessage<Snapshot>, IEquatable<Snapshot>, IDeepCloneable<Snapshot>, IBufferMessage, IMessage
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 focuses on the \u003ccode\u003eSnapshot\u003c/code\u003e class within the \u003ccode\u003eGoogle.Cloud.PubSub.V1\u003c/code\u003e namespace, providing documentation for its different versions, ranging from 2.3.0 to 3.23.0, with 3.23.0 being the latest version.\u003c/p\u003e\n"],["\u003cp\u003eSnapshots in this context are resources utilized in Seek operations to handle message acknowledgments collectively, which can allow to set the acknowledgment status of messages in an existing subscription.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSnapshot\u003c/code\u003e class implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, indicating its role in message handling and object management within the Google Pub/Sub environment.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003eSnapshot\u003c/code\u003e class include \u003ccode\u003eExpireTime\u003c/code\u003e, which determines the snapshot's lifespan based on the age of the oldest unacknowledged message, and \u003ccode\u003eName\u003c/code\u003e, \u003ccode\u003eTopic\u003c/code\u003e and \u003ccode\u003eSnapshotName\u003c/code\u003e, which identify the snapshot and the topic it relates to, and \u003ccode\u003eLabels\u003c/code\u003e, which allow you to manage labels in pub/sub.\u003c/p\u003e\n"],["\u003cp\u003eConstructors for creating \u003ccode\u003eSnapshot\u003c/code\u003e objects are available, either defaultly or by copying an existing \u003ccode\u003eSnapshot\u003c/code\u003e, highlighting the flexibility in how these resources can be initialized and managed.\u003c/p\u003e\n"]]],[],null,[]]
