Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::SeekRequest (v1.6.0)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::SeekRequest.

Request for the Seek method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#snapshot

def snapshot() -> ::String
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}.

    Note: The following fields are mutually exclusive: snapshot, time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#snapshot=

def snapshot=(value) -> ::String
Parameter
  • value (::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}.

    Note: The following fields are mutually exclusive: snapshot, time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: snapshot, time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#subscription

def subscription() -> ::String
Returns
  • (::String) — Required. The subscription to affect.

#subscription=

def subscription=(value) -> ::String
Parameter
  • value (::String) — Required. The subscription to affect.
Returns
  • (::String) — Required. The subscription to affect.

#time

def time() -> ::Google::Protobuf::Timestamp
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.

    Note: The following fields are mutually exclusive: time, snapshot. If a field in that set is populated, all other fields in the set will automatically be cleared.

#time=

def time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.

    Note: The following fields are mutually exclusive: time, snapshot. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: time, snapshot. If a field in that set is populated, all other fields in the set will automatically be cleared.