Reference documentation and code samples for the Cloud PubSub V1 Client class SeekRequest.
Request for the Seek
method.
Generated from protobuf message google.pubsub.v1.SeekRequest
Namespace
Google \ Cloud \ PubSub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ subscription
string
Required. The subscription to affect.
↳ time
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.
↳ 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}
.
getSubscription
Required. The subscription to affect.
string
setSubscription
Required. The subscription to affect.
var
string
$this
getTime
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.
hasTime
setTime
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.
$this
getSnapshot
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}
.
string
hasSnapshot
setSnapshot
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}
.
var
string
$this
getTarget
string