Class: Google::Apis::PubsubV1::Snapshot
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::Snapshot
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/pubsub_v1/classes.rb,
generated/google/apis/pubsub_v1/representations.rb,
generated/google/apis/pubsub_v1/representations.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.
BETA: This feature is part of a beta release. This API might be
changed in backward-incompatible ways and is not recommended for production
use. It is not subject to any SLA or deprecation policy.
Instance Attribute Summary collapse
-
#expire_time ⇒ String
The snapshot is guaranteed to exist up until this time.
- #labels ⇒ Hash<String,String>
-
#name ⇒ String
The name of the snapshot.
-
#topic ⇒ String
The name of the topic from which this snapshot is retaining messages.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Snapshot
constructor
A new instance of Snapshot.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Snapshot
Returns a new instance of Snapshot
855 856 857 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 855 def initialize(**args) update!(**args) end |
Instance Attribute Details
#expire_time ⇒ String
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.
Corresponds to the JSON property expireTime
837 838 839 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 837 def expire_time @expire_time end |
#labels ⇒ Hash<String,String>
See Creating and
managing labels.
Corresponds to the JSON property labels
843 844 845 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 843 def labels @labels end |
#name ⇒ String
The name of the snapshot.
Corresponds to the JSON property name
848 849 850 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 848 def name @name end |
#topic ⇒ String
The name of the topic from which this snapshot is retaining messages.
Corresponds to the JSON property topic
853 854 855 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 853 def topic @topic end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
860 861 862 863 864 865 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 860 def update!(**args) @expire_time = args[:expire_time] if args.key?(:expire_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @topic = args[:topic] if args.key?(:topic) end |