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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SeekRequestImplements
SeekRequestOrBuilderStatic Fields
CURSOR_FIELD_NUMBER
public static final int CURSOR_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAMED_TARGET_FIELD_NUMBER
public static final int NAMED_TARGET_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static SeekRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
SeekRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static SeekRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
newBuilder(SeekRequest prototype)
public static SeekRequest.Builder newBuilder(SeekRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
SeekRequest |
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
parseDelimitedFrom(InputStream input)
public static SeekRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static SeekRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SeekRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SeekRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static SeekRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SeekRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SeekRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SeekRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SeekRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<SeekRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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. |
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 |
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. |
getParserForType()
public Parser<SeekRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<SeekRequest> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SeekRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SeekRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SeekRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SeekRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |