Snapshot
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
A snapshot resource. Snapshots are used in Seek <https://cloud.google.com/pubsub/docs/replay-overview>
__
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.
Attributes
Name
Description
name
:noindex:
str
Optional. The name of the snapshot.
topic
:noindex:
str
Optional. The name of the topic from which this snapshot is retaining messages.
expire_time
:noindex:
google.protobuf.timestamp_pb2.Timestamp
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
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.labels
:noindex:
MutableMapping[str, str]
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Classes
LabelsEntry
LabelsEntry
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
The abstract base class for a message.
Parameters
Name
Description
kwargs
dict
Keys and values corresponding to the fields of the message.
mapping
Union[dict, .Message
]
A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if mapping
is a mapping type or there are keyword parameters.
