class SeekRequest extends Message

Request for the Seek method.

Protobuf type Google\Pubsub\V1\SeekRequest

Properties

protected $target

Methods

__construct()

No description

string
getSubscription()

The subscription to affect.

setSubscription(string $var)

The subscription to affect.

getTime()

The time to seek to.

setTime(Timestamp $var)

The time to seek to.

string
getSnapshot()

The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription.

setSnapshot(string $var)

The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription.

string
getTarget()

No description

Details

at line 26
__construct()

at line 37
string getSubscription()

The subscription to affect.

Generated from protobuf field string subscription = 1;

Return Value

string

at line 48
setSubscription(string $var)

The subscription to affect.

Generated from protobuf field string subscription = 1;

Parameters

string $var

at line 70
Timestamp 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.

Generated from protobuf field .google.protobuf.Timestamp time = 2;

Return Value

Timestamp

at line 91
setTime(Timestamp $var)

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.

Generated from protobuf field .google.protobuf.Timestamp time = 2;

Parameters

Timestamp $var

at line 105
string 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}.

Generated from protobuf field string snapshot = 3;

Return Value

string

at line 118
setSnapshot(string $var)

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

Generated from protobuf field string snapshot = 3;

Parameters

string $var

at line 127
string getTarget()

Return Value

string