Cloud PubSub V1 Client - Class SeekRequest (1.48.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
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.

Returns
Type
Description
string

setSubscription

Required. The subscription to affect.

Parameter
Name
Description
var
string
Returns
Type
Description
$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.

Returns
Type
Description

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.

Parameter
Name
Description
Returns
Type
Description
$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} .

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTarget

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: