Class: Google::Apis::PubsubV1::SeekRequest
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::SeekRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb
Overview
Request for the Seek
method.
Instance Attribute Summary collapse
-
#snapshot ⇒ String
Optional.
-
#time ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SeekRequest
constructor
A new instance of SeekRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SeekRequest
Returns a new instance of SeekRequest.
1514 1515 1516 |
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1514 def initialize(**args) update!(**args) end |
Instance Attribute Details
#snapshot ⇒ String
Optional. 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`
1498 1499 1500 |
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1498 def snapshot @snapshot end |
#time ⇒ String
Optional. 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
1512 1513 1514 |
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1512 def time @time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1519 1520 1521 1522 |
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1519 def update!(**args) @snapshot = args[:snapshot] if args.key?(:snapshot) @time = args[:time] if args.key?(:time) end |