Class: Google::Pubsub::V1::SeekRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

Request for the +Seek+ method.

ALPHA: This feature is part of an alpha 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

Instance Attribute Details

#snapshot ⇒ String

Returns 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) —

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



622
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 622

class SeekRequest; end

#subscription ⇒ String

Returns The subscription to affect.

Returns:

  • (String) —

    The subscription to affect.



622
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 622

class SeekRequest; end

#time ⇒ Google::Protobuf::Timestamp

Returns 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) —

    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.



622
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 622

class SeekRequest; end