Reference documentation and code samples for the Cloud PubSub V1 Client class Snapshot.
A snapshot resource. Snapshots are used inSeekoperations, 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.
Generated from protobuf messagegoogle.pubsub.v1.Snapshot
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. The name of the snapshot.
↳ topic
string
Optional. The name of the topic from which this snapshot is retaining messages.
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 is7 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.
Optional. The name of the topic from which this snapshot is retaining
messages.
Returns
Type
Description
string
setTopic
Optional. The name of the topic from which this snapshot is retaining
messages.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getExpireTime
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 is7 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.
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 is7 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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class Snapshot (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.Snapshot)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.Snapshot)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.Snapshot)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.Snapshot)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.Snapshot)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.Snapshot)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.Snapshot)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.Snapshot)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.Snapshot)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.Snapshot)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.Snapshot)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.Snapshot)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.Snapshot)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.Snapshot)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.Snapshot)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.Snapshot)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.Snapshot)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.Snapshot)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.Snapshot)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.Snapshot)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.Snapshot)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.Snapshot)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.Snapshot)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.Snapshot)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.Snapshot)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.Snapshot) \nReference documentation and code samples for the Cloud PubSub V1 Client class Snapshot.\n\nA snapshot resource. Snapshots are used in\n[Seek](https://cloud.google.com/pubsub/docs/replay-overview)\noperations, which allow you to manage message acknowledgments in bulk. That\nis, you can set the acknowledgment state of messages in an existing\nsubscription to the state captured by a snapshot.\n\nGenerated from protobuf message `google.pubsub.v1.Snapshot`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOptional. The name of the snapshot.\n\n### setName\n\nOptional. The name of the snapshot.\n\n### getTopic\n\nOptional. The name of the topic from which this snapshot is retaining\nmessages.\n\n### setTopic\n\nOptional. The name of the topic from which this snapshot is retaining\nmessages.\n\n### getExpireTime\n\nOptional. The snapshot is guaranteed to exist up until this time.\n\nA newly-created snapshot expires no later than 7 days from the time of its\ncreation. Its exact lifetime is determined at creation by the existing\nbacklog in the source subscription. Specifically, the lifetime of the\nsnapshot is `7 days - (age of oldest unacked message in the subscription)`.\nFor example, consider a subscription whose oldest unacked message is 3 days\nold. If a snapshot is created from this subscription, the snapshot -- which\nwill always capture this 3-day-old backlog as long as the snapshot\nexists -- will expire in 4 days. The service will refuse to create a\nsnapshot that would expire in less than 1 hour after creation.\n\n### hasExpireTime\n\n### clearExpireTime\n\n### setExpireTime\n\nOptional. The snapshot is guaranteed to exist up until this time.\n\nA newly-created snapshot expires no later than 7 days from the time of its\ncreation. Its exact lifetime is determined at creation by the existing\nbacklog in the source subscription. Specifically, the lifetime of the\nsnapshot is `7 days - (age of oldest unacked message in the subscription)`.\nFor example, consider a subscription whose oldest unacked message is 3 days\nold. If a snapshot is created from this subscription, the snapshot -- which\nwill always capture this 3-day-old backlog as long as the snapshot\nexists -- will expire in 4 days. The service will refuse to create a\nsnapshot that would expire in less than 1 hour after creation.\n\n### getLabels\n\nOptional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).\n\n### setLabels\n\nOptional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels)."]]
