com.google.pubsub.v1

Interface SeekRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SeekRequest, SeekRequest.Builder

public interface SeekRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getSnapshot() The snapshot to seek to.
com.google.protobuf.ByteString	getSnapshotBytes() The snapshot to seek to.
String	getSubscription() Required.
com.google.protobuf.ByteString	getSubscriptionBytes() Required.
SeekRequest.TargetCase	getTargetCase()
com.google.protobuf.Timestamp	getTime() The time to seek to.
com.google.protobuf.TimestampOrBuilder	getTimeOrBuilder() The time to seek to.
boolean	hasSnapshot() The snapshot to seek to.
boolean	hasTime() The time to seek to.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSubscription

String getSubscription()

 Required. The subscription to affect.
 

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

Returns:

The subscription.

getSubscriptionBytes

com.google.protobuf.ByteString getSubscriptionBytes()

 Required. The subscription to affect.
 

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

Returns:

The bytes for subscription.

hasTime

boolean hasTime()

 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;

Returns:

Whether the time field is set.

getTime

com.google.protobuf.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.
 

.google.protobuf.Timestamp time = 2;

Returns:

The time.

getTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getTimeOrBuilder()

 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;

hasSnapshot

boolean hasSnapshot()

 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.resource_reference) = { ... }

Returns:

Whether the snapshot field is set.

getSnapshot

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

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

Returns:

The snapshot.

getSnapshotBytes

com.google.protobuf.ByteString getSnapshotBytes()

 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.resource_reference) = { ... }

Returns:

The bytes for snapshot.

getTargetCase

SeekRequest.TargetCase getTargetCase()