Class: Google::Cloud::PubSub::V1::Snapshot
- Inherits:
-
Object
- Object
- Google::Cloud::PubSub::V1::Snapshot
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/pubsub/v1/pubsub.rb
Overview
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.
Defined Under Namespace
Classes: LabelsEntry
Instance Attribute Summary collapse
-
#expire_time ⇒ ::Google::Protobuf::Timestamp
The snapshot is guaranteed to exist up until this time.
- #labels ⇒ ::Google::Protobuf::Map{::String => ::String}
-
#name ⇒ ::String
The name of the snapshot.
-
#topic ⇒ ::String
The name of the topic from which this snapshot is retaining messages.
Instance Attribute Details
#expire_time ⇒ ::Google::Protobuf::Timestamp
Returns 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.
936 937 938 939 940 941 942 943 944 945 946 947 948 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 936 class Snapshot include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns See Creating and managing labels.
936 937 938 939 940 941 942 943 944 945 946 947 948 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 936 class Snapshot include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#name ⇒ ::String
Returns The name of the snapshot.
936 937 938 939 940 941 942 943 944 945 946 947 948 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 936 class Snapshot include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#topic ⇒ ::String
Returns The name of the topic from which this snapshot is retaining messages.
936 937 938 939 940 941 942 943 944 945 946 947 948 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 936 class Snapshot include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |