Class SeekRequest

public final class SeekRequest extends GeneratedMessageV3 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

Fields

CURSOR_FIELD_NUMBER

public static final int CURSOR_FIELD_NUMBER
Field Value
TypeDescription
int

NAMED_TARGET_FIELD_NUMBER

public static final int NAMED_TARGET_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
Cursor

The cursor.

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
TypeDescription
CursorOrBuilder

getDefaultInstance()

public static SeekRequest getDefaultInstance()
Returns
TypeDescription
SeekRequest

getDefaultInstanceForType()

public SeekRequest getDefaultInstanceForType()
Returns
TypeDescription
SeekRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getNamedTarget()

public SeekRequest.NamedTarget getNamedTarget()

A named target.

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

Returns
TypeDescription
SeekRequest.NamedTarget

The namedTarget.

getNamedTargetValue()

public int getNamedTargetValue()

A named target.

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

Returns
TypeDescription
int

The enum numeric value on the wire for namedTarget.

getParserForType()

public Parser<SeekRequest> getParserForType()
Returns
TypeDescription
Parser<SeekRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTargetCase()

public SeekRequest.TargetCase getTargetCase()
Returns
TypeDescription
SeekRequest.TargetCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the cursor field is set.

hasNamedTarget()

public boolean hasNamedTarget()

A named target.

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

Returns
TypeDescription
boolean

Whether the namedTarget field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static SeekRequest.Builder newBuilder()
Returns
TypeDescription
SeekRequest.Builder

newBuilder(SeekRequest prototype)

public static SeekRequest.Builder newBuilder(SeekRequest prototype)
Parameter
NameDescription
prototypeSeekRequest
Returns
TypeDescription
SeekRequest.Builder

newBuilderForType()

public SeekRequest.Builder newBuilderForType()
Returns
TypeDescription
SeekRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SeekRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SeekRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static SeekRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SeekRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SeekRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SeekRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SeekRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SeekRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SeekRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SeekRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SeekRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SeekRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SeekRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SeekRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SeekRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SeekRequest> parser()
Returns
TypeDescription
Parser<SeekRequest>

toBuilder()

public SeekRequest.Builder toBuilder()
Returns
TypeDescription
SeekRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException