Class SeekRequest.Builder (1.16.5)

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

Request to update the stream's delivery cursor based on the given target. Resets the server available tokens to 0. SeekRequests past head result in stream breakage.

SeekRequests may not be sent while another SeekRequest is outstanding (i.e., has not received a SeekResponse) on the same stream.

Protobuf type google.cloud.pubsublite.v1.SeekRequest

Static Methods

getDescriptor()

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

Methods

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

clearCursor()

public SeekRequest.Builder clearCursor()

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Returns
Type Description
SeekRequest.Builder

clearNamedTarget()

public SeekRequest.Builder clearNamedTarget()

A named target.

.google.cloud.pubsublite.v1.SeekRequest.NamedTarget named_target = 1;

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

clearTarget()

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

getCursor()

public Cursor getCursor()

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Returns
Type Description
Cursor

The cursor.

getCursorBuilder()

public Cursor.Builder getCursorBuilder()

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Returns
Type Description
Cursor.Builder

getCursorOrBuilder()

public CursorOrBuilder getCursorOrBuilder()

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Returns
Type Description
CursorOrBuilder

getDefaultInstanceForType()

public SeekRequest getDefaultInstanceForType()
Returns
Type Description
SeekRequest

getDescriptorForType()

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

getNamedTarget()

public SeekRequest.NamedTarget getNamedTarget()

A named target.

.google.cloud.pubsublite.v1.SeekRequest.NamedTarget named_target = 1;

Returns
Type Description
SeekRequest.NamedTarget

The namedTarget.

getNamedTargetValue()

public int getNamedTargetValue()

A named target.

.google.cloud.pubsublite.v1.SeekRequest.NamedTarget named_target = 1;

Returns
Type Description
int

The enum numeric value on the wire for namedTarget.

getTargetCase()

public SeekRequest.TargetCase getTargetCase()
Returns
Type Description
SeekRequest.TargetCase

hasCursor()

public boolean hasCursor()

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Returns
Type Description
boolean

Whether the cursor field is set.

hasNamedTarget()

public boolean hasNamedTarget()

A named target.

.google.cloud.pubsublite.v1.SeekRequest.NamedTarget named_target = 1;

Returns
Type Description
boolean

Whether the namedTarget field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCursor(Cursor value)

public SeekRequest.Builder mergeCursor(Cursor value)

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Parameter
Name Description
value Cursor
Returns
Type Description
SeekRequest.Builder

mergeFrom(SeekRequest other)

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

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

setCursor(Cursor value)

public SeekRequest.Builder setCursor(Cursor value)

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Parameter
Name Description
value Cursor
Returns
Type Description
SeekRequest.Builder

setCursor(Cursor.Builder builderForValue)

public SeekRequest.Builder setCursor(Cursor.Builder builderForValue)

A target corresponding to the cursor, pointing to anywhere in the topic partition.

.google.cloud.pubsublite.v1.Cursor cursor = 2;

Parameter
Name Description
builderForValue Cursor.Builder
Returns
Type Description
SeekRequest.Builder

setNamedTarget(SeekRequest.NamedTarget value)

public SeekRequest.Builder setNamedTarget(SeekRequest.NamedTarget value)

A named target.

.google.cloud.pubsublite.v1.SeekRequest.NamedTarget named_target = 1;

Parameter
Name Description
value SeekRequest.NamedTarget

The namedTarget to set.

Returns
Type Description
SeekRequest.Builder

This builder for chaining.

setNamedTargetValue(int value)

public SeekRequest.Builder setNamedTargetValue(int value)

A named target.

.google.cloud.pubsublite.v1.SeekRequest.NamedTarget named_target = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for namedTarget to set.

Returns
Type Description
SeekRequest.Builder

This builder for chaining.