Class: Google::Cloud::PubSub::V1::SeekRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

Overview

Request for the Seek method.

Instance Attribute Summary collapse

Instance Attribute Details

#snapshot ⇒ ::String

Returns 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}.

Returns:

  • (::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}.



1688
1689
1690
1691
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1688

class SeekRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subscription ⇒ ::String

Returns Required. The subscription to affect.

Returns:

  • (::String) —

    Required. The subscription to affect.



1688
1689
1690
1691
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1688

class SeekRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#time ⇒ ::Google::Protobuf::Timestamp

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



1688
1689
1690
1691
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1688

class SeekRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end