Interface SeekRequestOrBuilder (1.126.6)

public interface SeekRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSnapshot()

public abstract String getSnapshot()

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

string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The snapshot.

getSnapshotBytes()

public abstract ByteString getSnapshotBytes()

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

string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for snapshot.

getSubscription()

public abstract String getSubscription()

Required. The subscription to affect.

string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The subscription.

getSubscriptionBytes()

public abstract ByteString getSubscriptionBytes()

Required. The subscription to affect.

string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for subscription.

getTargetCase()

public abstract SeekRequest.TargetCase getTargetCase()

Returns
Type	Description
`SeekRequest.TargetCase`

getTime()

public abstract Timestamp getTime()

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.

.google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Timestamp`	The time.

getTimeOrBuilder()

public abstract TimestampOrBuilder getTimeOrBuilder()

.google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TimestampOrBuilder`

hasSnapshot()

public abstract boolean hasSnapshot()

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

string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`boolean`	Whether the snapshot field is set.

hasTime()

public abstract boolean hasTime()

.google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the time field is set.