Class: Google::Apis::PubsubV1::SeekRequest
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::SeekRequest
- 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
Request for the Seek
method.
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
-
#snapshot ⇒ String
The snapshot to seek to.
-
#time ⇒ String
The time to seek to.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SeekRequest
constructor
A new instance of SeekRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SeekRequest
Returns a new instance of SeekRequest
734 735 736 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 734 def initialize(**args) update!(**args) end |
Instance Attribute Details
#snapshot ⇒ String
The snapshot to seek to. The snapshot's topic must be the same as that of
the provided subscription.
Format is projects/
project/snapshots/
snap`.
Corresponds to the JSON property
snapshot`
717 718 719 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 717 def snapshot @snapshot end |
#time ⇒ String
The time to seek to.
Messages retained in the subscription that were published before this
time are marked as acknowledged, and messages retained in the
subscription that were published after this time are marked as
unacknowledged. Note that this operation affects only those messages
retained in the subscription (configured by the combination of
message_retention_duration
and retain_acked_messages
). For example,
if time
corresponds to a point before the message retention
window (or to a point before the system's notion of the subscription
creation time), only retained messages will be marked as unacknowledged,
and already-expunged messages will not be restored.
Corresponds to the JSON property time
732 733 734 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 732 def time @time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
739 740 741 742 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 739 def update!(**args) @snapshot = args[:snapshot] if args.key?(:snapshot) @time = args[:time] if args.key?(:time) end |