Class SeekRequest.Builder (1.133.0)

public static final class SeekRequest.Builder extends GeneratedMessageV3.Builder<SeekRequest.Builder> implements SeekRequestOrBuilder

Request for the Seek method.

Protobuf type google.pubsub.v1.SeekRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SeekRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SeekRequest.Builder
Overrides

build()

public SeekRequest build()
Returns
Type Description
SeekRequest

buildPartial()

public SeekRequest buildPartial()
Returns
Type Description
SeekRequest

clear()

public SeekRequest.Builder clear()
Returns
Type Description
SeekRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SeekRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SeekRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SeekRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SeekRequest.Builder
Overrides

clearSnapshot()

public SeekRequest.Builder clearSnapshot()

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
SeekRequest.Builder

This builder for chaining.

clearSubscription()

public SeekRequest.Builder clearSubscription()

Required. The subscription to affect.

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

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

clearTarget()

public SeekRequest.Builder clearTarget()
Returns
Type Description
SeekRequest.Builder

clearTime()

public SeekRequest.Builder clearTime()

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
SeekRequest.Builder

clone()

public SeekRequest.Builder clone()
Returns
Type Description
SeekRequest.Builder
Overrides

getDefaultInstanceForType()

public SeekRequest getDefaultInstanceForType()
Returns
Type Description
SeekRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getSnapshot()

public 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 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 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 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 SeekRequest.TargetCase getTargetCase()
Returns
Type Description
SeekRequest.TargetCase

getTime()

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

getTimeBuilder()

public Timestamp.Builder getTimeBuilder()

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
Builder

getTimeOrBuilder()

public TimestampOrBuilder getTimeOrBuilder()

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
TimestampOrBuilder

hasSnapshot()

public 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 boolean hasTime()

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
boolean

Whether the time field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SeekRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SeekRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SeekRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SeekRequest.Builder
Overrides

mergeFrom(SeekRequest other)

public SeekRequest.Builder mergeFrom(SeekRequest other)
Parameter
Name Description
other SeekRequest
Returns
Type Description
SeekRequest.Builder

mergeTime(Timestamp value)

public SeekRequest.Builder mergeTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
SeekRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SeekRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SeekRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SeekRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SeekRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SeekRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SeekRequest.Builder
Overrides

setSnapshot(String value)

public SeekRequest.Builder setSnapshot(String value)

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

Parameter
Name Description
value String

The snapshot to set.

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

setSnapshotBytes(ByteString value)

public SeekRequest.Builder setSnapshotBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for snapshot to set.

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

setSubscription(String value)

public SeekRequest.Builder setSubscription(String value)

Required. The subscription to affect.

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

Parameter
Name Description
value String

The subscription to set.

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

setSubscriptionBytes(ByteString value)

public SeekRequest.Builder setSubscriptionBytes(ByteString value)

Required. The subscription to affect.

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

Parameter
Name Description
value ByteString

The bytes for subscription to set.

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

setTime(Timestamp value)

public SeekRequest.Builder setTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
SeekRequest.Builder

setTime(Timestamp.Builder builderForValue)

public SeekRequest.Builder setTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SeekRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SeekRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SeekRequest.Builder
Overrides