org.tikv.kvproto

Class Kvrpcpb.ScanRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tikv.kvproto.Kvrpcpb.ScanRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Kvrpcpb.ScanRequestOrBuilder

Enclosing class:

Kvrpcpb

public static final class Kvrpcpb.ScanRequest
extends com.google.protobuf.GeneratedMessageV3
implements Kvrpcpb.ScanRequestOrBuilder

 Scan fetches values for a range of keys; it is part of the transaction with
 starting timestamp = `version`.
 

Protobuf type kvrpcpb.ScanRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kvrpcpb.ScanRequest.Builder Scan fetches values for a range of keys; it is part of the transaction with starting timestamp = `version`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_FIELD_NUMBER
static int	END_KEY_FIELD_NUMBER
static int	KEY_ONLY_FIELD_NUMBER
static int	LIMIT_FIELD_NUMBER
static int	REVERSE_FIELD_NUMBER
static int	SAMPLE_STEP_FIELD_NUMBER
static int	START_KEY_FIELD_NUMBER
static int	VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.ContextOrBuilder	getContextOrBuilder() .kvrpcpb.Context context = 1;
static Kvrpcpb.ScanRequest	getDefaultInstance()
Kvrpcpb.ScanRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.ByteString	getEndKey() For compatibility, when scanning forward, the range to scan is [start_key, end_key), where start_key < end_key; and when scanning backward, it scans [end_key, start_key) in descending order, where end_key < start_key.
boolean	getKeyOnly() Return only the keys found by scanning, not their values.
int	getLimit() The maximum number of results to return.
com.google.protobuf.Parser<Kvrpcpb.ScanRequest>	getParserForType()
boolean	getReverse() bool reverse = 6;
int	getSampleStep() If sample_step > 0, skips 'sample_step - 1' number of keys after each returned key.
int	getSerializedSize()
com.google.protobuf.ByteString	getStartKey() bytes start_key = 2;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
long	getVersion() uint64 version = 4;
boolean	hasContext() .kvrpcpb.Context context = 1;
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Kvrpcpb.ScanRequest.Builder	newBuilder()
static Kvrpcpb.ScanRequest.Builder	newBuilder(Kvrpcpb.ScanRequest prototype)
Kvrpcpb.ScanRequest.Builder	newBuilderForType()
protected Kvrpcpb.ScanRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Kvrpcpb.ScanRequest	parseDelimitedFrom(InputStream input)
static Kvrpcpb.ScanRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.ScanRequest	parseFrom(byte[] data)
static Kvrpcpb.ScanRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.ScanRequest	parseFrom(ByteBuffer data)
static Kvrpcpb.ScanRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.ScanRequest	parseFrom(com.google.protobuf.ByteString data)
static Kvrpcpb.ScanRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.ScanRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Kvrpcpb.ScanRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.ScanRequest	parseFrom(InputStream input)
static Kvrpcpb.ScanRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Kvrpcpb.ScanRequest>	parser()
Kvrpcpb.ScanRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

START_KEY_FIELD_NUMBER

public static final int START_KEY_FIELD_NUMBER

See Also:

Constant Field Values

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

See Also:

Constant Field Values

KEY_ONLY_FIELD_NUMBER

public static final int KEY_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

REVERSE_FIELD_NUMBER

public static final int REVERSE_FIELD_NUMBER

See Also:

Constant Field Values

END_KEY_FIELD_NUMBER

public static final int END_KEY_FIELD_NUMBER

See Also:

Constant Field Values

SAMPLE_STEP_FIELD_NUMBER

public static final int SAMPLE_STEP_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasContext

public boolean hasContext()

.kvrpcpb.Context context = 1;

Specified by:

hasContext in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

Whether the context field is set.

getContext

public Kvrpcpb.Context getContext()

.kvrpcpb.Context context = 1;

Specified by:

getContext in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The context.

getContextOrBuilder

public Kvrpcpb.ContextOrBuilder getContextOrBuilder()

.kvrpcpb.Context context = 1;

Specified by:

getContextOrBuilder in interface Kvrpcpb.ScanRequestOrBuilder

getStartKey

public com.google.protobuf.ByteString getStartKey()

bytes start_key = 2;

Specified by:

getStartKey in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The startKey.

getLimit

public int getLimit()

 The maximum number of results to return.
 

uint32 limit = 3;

Specified by:

getLimit in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The limit.

getVersion

public long getVersion()

uint64 version = 4;

Specified by:

getVersion in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The version.

getKeyOnly

public boolean getKeyOnly()

 Return only the keys found by scanning, not their values.
 

bool key_only = 5;

Specified by:

getKeyOnly in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The keyOnly.

getReverse

public boolean getReverse()

bool reverse = 6;

Specified by:

getReverse in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The reverse.

getEndKey

public com.google.protobuf.ByteString getEndKey()

 For compatibility, when scanning forward, the range to scan is [start_key, end_key), where start_key < end_key;
 and when scanning backward, it scans [end_key, start_key) in descending order, where end_key < start_key.
 

bytes end_key = 7;

Specified by:

getEndKey in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The endKey.

getSampleStep

public int getSampleStep()

 If sample_step > 0, skips 'sample_step - 1' number of keys after each returned key.
 locks are not checked.
 

uint32 sample_step = 8;

Specified by:

getSampleStep in interface Kvrpcpb.ScanRequestOrBuilder

Returns:

The sampleStep.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Kvrpcpb.ScanRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Kvrpcpb.ScanRequest parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public Kvrpcpb.ScanRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Kvrpcpb.ScanRequest.Builder newBuilder()

newBuilder

public static Kvrpcpb.ScanRequest.Builder newBuilder(Kvrpcpb.ScanRequest prototype)

toBuilder

public Kvrpcpb.ScanRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Kvrpcpb.ScanRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Kvrpcpb.ScanRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Kvrpcpb.ScanRequest> parser()

getParserForType

public com.google.protobuf.Parser<Kvrpcpb.ScanRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Kvrpcpb.ScanRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder