Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::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.
#expire_time=
def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::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.
Returns
-
(::Google::Protobuf::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
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. See Creating and managing labels.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. See Creating and managing labels.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. See Creating and managing labels.
#name
def name() -> ::String
Returns
- (::String) — Optional. The name of the snapshot.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Optional. The name of the snapshot.
Returns
- (::String) — Optional. The name of the snapshot.
#topic
def topic() -> ::String
Returns
- (::String) — Optional. The name of the topic from which this snapshot is retaining messages.
#topic=
def topic=(value) -> ::String
Parameter
- value (::String) — Optional. The name of the topic from which this snapshot is retaining messages.
Returns
- (::String) — Optional. The name of the topic from which this snapshot is retaining messages.