org.tikv.kvproto

Interface Kvrpcpb.ScanRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Kvrpcpb.ScanRequest, Kvrpcpb.ScanRequest.Builder

Enclosing class:

Kvrpcpb

public static interface Kvrpcpb.ScanRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.ContextOrBuilder	getContextOrBuilder() .kvrpcpb.Context context = 1;
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.
boolean	getReverse() bool reverse = 6;
int	getSampleStep() If sample_step > 0, skips 'sample_step - 1' number of keys after each returned key.
com.google.protobuf.ByteString	getStartKey() bytes start_key = 2;
long	getVersion() uint64 version = 4;
boolean	hasContext() .kvrpcpb.Context context = 1;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasContext

boolean hasContext()

.kvrpcpb.Context context = 1;

Returns:

Whether the context field is set.

getContext

Kvrpcpb.Context getContext()

.kvrpcpb.Context context = 1;

Returns:

The context.

getContextOrBuilder

Kvrpcpb.ContextOrBuilder getContextOrBuilder()

.kvrpcpb.Context context = 1;

getStartKey

com.google.protobuf.ByteString getStartKey()

bytes start_key = 2;

Returns:

The startKey.

getLimit

int getLimit()

 The maximum number of results to return.
 

uint32 limit = 3;

Returns:

The limit.

getVersion

long getVersion()

uint64 version = 4;

Returns:

The version.

getKeyOnly

boolean getKeyOnly()

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

bool key_only = 5;

Returns:

The keyOnly.

getReverse

boolean getReverse()

bool reverse = 6;

Returns:

The reverse.

getEndKey

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;

Returns:

The endKey.

getSampleStep

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;

Returns:

The sampleStep.