org.tikv.kvproto

类 Kvrpcpb.ScanRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

org.tikv.kvproto.Kvrpcpb.ScanRequest.Builder

所有已实现的接口:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Kvrpcpb.ScanRequestOrBuilder

封闭类:

Kvrpcpb.ScanRequest

public static final class Kvrpcpb.ScanRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
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

方法概要

限定符和类型	方法和说明
Kvrpcpb.ScanRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Kvrpcpb.ScanRequest	build()
Kvrpcpb.ScanRequest	buildPartial()
Kvrpcpb.ScanRequest.Builder	clear()
Kvrpcpb.ScanRequest.Builder	clearContext() .kvrpcpb.Context context = 1;
Kvrpcpb.ScanRequest.Builder	clearEndKey() 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.
Kvrpcpb.ScanRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Kvrpcpb.ScanRequest.Builder	clearKeyOnly() Return only the keys found by scanning, not their values.
Kvrpcpb.ScanRequest.Builder	clearLimit() The maximum number of results to return.
Kvrpcpb.ScanRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Kvrpcpb.ScanRequest.Builder	clearReverse() bool reverse = 6;
Kvrpcpb.ScanRequest.Builder	clearSampleStep() If sample_step > 0, skips 'sample_step - 1' number of keys after each returned key.
Kvrpcpb.ScanRequest.Builder	clearStartKey() bytes start_key = 2;
Kvrpcpb.ScanRequest.Builder	clearVersion() uint64 version = 4;
Kvrpcpb.ScanRequest.Builder	clone()
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.Context.Builder	getContextBuilder() .kvrpcpb.Context context = 1;
Kvrpcpb.ContextOrBuilder	getContextOrBuilder() .kvrpcpb.Context context = 1;
Kvrpcpb.ScanRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Kvrpcpb.ScanRequest.Builder	mergeContext(Kvrpcpb.Context value) .kvrpcpb.Context context = 1;
Kvrpcpb.ScanRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Kvrpcpb.ScanRequest.Builder	mergeFrom(Kvrpcpb.ScanRequest other)
Kvrpcpb.ScanRequest.Builder	mergeFrom(com.google.protobuf.Message other)
Kvrpcpb.ScanRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Kvrpcpb.ScanRequest.Builder	setContext(Kvrpcpb.Context.Builder builderForValue) .kvrpcpb.Context context = 1;
Kvrpcpb.ScanRequest.Builder	setContext(Kvrpcpb.Context value) .kvrpcpb.Context context = 1;
Kvrpcpb.ScanRequest.Builder	setEndKey(com.google.protobuf.ByteString value) 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.
Kvrpcpb.ScanRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Kvrpcpb.ScanRequest.Builder	setKeyOnly(boolean value) Return only the keys found by scanning, not their values.
Kvrpcpb.ScanRequest.Builder	setLimit(int value) The maximum number of results to return.
Kvrpcpb.ScanRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Kvrpcpb.ScanRequest.Builder	setReverse(boolean value) bool reverse = 6;
Kvrpcpb.ScanRequest.Builder	setSampleStep(int value) If sample_step > 0, skips 'sample_step - 1' number of keys after each returned key.
Kvrpcpb.ScanRequest.Builder	setStartKey(com.google.protobuf.ByteString value) bytes start_key = 2;
Kvrpcpb.ScanRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Kvrpcpb.ScanRequest.Builder	setVersion(long value) uint64 version = 4;

从类继承的方法 com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

从类继承的方法 com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

从类继承的方法 com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

从类继承的方法 java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.protobuf.MessageOrBuilder

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

从接口继承的方法 com.google.protobuf.MessageLite.Builder

mergeFrom

方法详细资料

getDescriptor

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

internalGetFieldAccessorTable

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

指定者:

internalGetFieldAccessorTable 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

clear

public Kvrpcpb.ScanRequest.Builder clear()

指定者:

clear 在接口中 com.google.protobuf.Message.Builder

指定者:

clear 在接口中 com.google.protobuf.MessageLite.Builder

覆盖:

clear 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

指定者:

getDescriptorForType 在接口中 com.google.protobuf.Message.Builder

指定者:

getDescriptorForType 在接口中 com.google.protobuf.MessageOrBuilder

覆盖:

getDescriptorForType 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

getDefaultInstanceForType

public Kvrpcpb.ScanRequest getDefaultInstanceForType()

指定者:

getDefaultInstanceForType 在接口中 com.google.protobuf.MessageLiteOrBuilder

指定者:

getDefaultInstanceForType 在接口中 com.google.protobuf.MessageOrBuilder

build

public Kvrpcpb.ScanRequest build()

指定者:

build 在接口中 com.google.protobuf.Message.Builder

指定者:

build 在接口中 com.google.protobuf.MessageLite.Builder

buildPartial

public Kvrpcpb.ScanRequest buildPartial()

指定者:

buildPartial 在接口中 com.google.protobuf.Message.Builder

指定者:

buildPartial 在接口中 com.google.protobuf.MessageLite.Builder

clone

public Kvrpcpb.ScanRequest.Builder clone()

指定者:

clone 在接口中 com.google.protobuf.Message.Builder

指定者:

clone 在接口中 com.google.protobuf.MessageLite.Builder

覆盖:

clone 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

setField

public Kvrpcpb.ScanRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

指定者:

setField 在接口中 com.google.protobuf.Message.Builder

覆盖:

setField 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

clearField

public Kvrpcpb.ScanRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

指定者:

clearField 在接口中 com.google.protobuf.Message.Builder

覆盖:

clearField 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

clearOneof

public Kvrpcpb.ScanRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

指定者:

clearOneof 在接口中 com.google.protobuf.Message.Builder

覆盖:

clearOneof 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

setRepeatedField

public Kvrpcpb.ScanRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)

指定者:

setRepeatedField 在接口中 com.google.protobuf.Message.Builder

覆盖:

setRepeatedField 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

addRepeatedField

public Kvrpcpb.ScanRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

指定者:

addRepeatedField 在接口中 com.google.protobuf.Message.Builder

覆盖:

addRepeatedField 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

mergeFrom

public Kvrpcpb.ScanRequest.Builder mergeFrom(com.google.protobuf.Message other)

指定者:

mergeFrom 在接口中 com.google.protobuf.Message.Builder

覆盖:

mergeFrom 在类中 com.google.protobuf.AbstractMessage.Builder<Kvrpcpb.ScanRequest.Builder>

mergeFrom

public Kvrpcpb.ScanRequest.Builder mergeFrom(Kvrpcpb.ScanRequest other)

isInitialized

public final boolean isInitialized()

指定者:

isInitialized 在接口中 com.google.protobuf.MessageLiteOrBuilder

覆盖:

isInitialized 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

mergeFrom

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

指定者:

mergeFrom 在接口中 com.google.protobuf.Message.Builder

指定者:

mergeFrom 在接口中 com.google.protobuf.MessageLite.Builder

覆盖:

mergeFrom 在类中 com.google.protobuf.AbstractMessage.Builder<Kvrpcpb.ScanRequest.Builder>

抛出:

IOException

hasContext

public boolean hasContext()

.kvrpcpb.Context context = 1;

指定者:

hasContext 在接口中 Kvrpcpb.ScanRequestOrBuilder

getContext

public Kvrpcpb.Context getContext()

.kvrpcpb.Context context = 1;

指定者:

getContext 在接口中 Kvrpcpb.ScanRequestOrBuilder

setContext

public Kvrpcpb.ScanRequest.Builder setContext(Kvrpcpb.Context value)

.kvrpcpb.Context context = 1;

setContext

public Kvrpcpb.ScanRequest.Builder setContext(Kvrpcpb.Context.Builder builderForValue)

.kvrpcpb.Context context = 1;

mergeContext

public Kvrpcpb.ScanRequest.Builder mergeContext(Kvrpcpb.Context value)

.kvrpcpb.Context context = 1;

clearContext

public Kvrpcpb.ScanRequest.Builder clearContext()

.kvrpcpb.Context context = 1;

getContextBuilder

public Kvrpcpb.Context.Builder getContextBuilder()

.kvrpcpb.Context context = 1;

getContextOrBuilder

public Kvrpcpb.ContextOrBuilder getContextOrBuilder()

.kvrpcpb.Context context = 1;

指定者:

getContextOrBuilder 在接口中 Kvrpcpb.ScanRequestOrBuilder

getStartKey

public com.google.protobuf.ByteString getStartKey()

bytes start_key = 2;

指定者:

getStartKey 在接口中 Kvrpcpb.ScanRequestOrBuilder

setStartKey

public Kvrpcpb.ScanRequest.Builder setStartKey(com.google.protobuf.ByteString value)

bytes start_key = 2;

clearStartKey

public Kvrpcpb.ScanRequest.Builder clearStartKey()

bytes start_key = 2;

getLimit

public int getLimit()

 The maximum number of results to return.
 

uint32 limit = 3;

指定者:

getLimit 在接口中 Kvrpcpb.ScanRequestOrBuilder

setLimit

public Kvrpcpb.ScanRequest.Builder setLimit(int value)

 The maximum number of results to return.
 

uint32 limit = 3;

clearLimit

public Kvrpcpb.ScanRequest.Builder clearLimit()

 The maximum number of results to return.
 

uint32 limit = 3;

getVersion

public long getVersion()

uint64 version = 4;

指定者:

getVersion 在接口中 Kvrpcpb.ScanRequestOrBuilder

setVersion

public Kvrpcpb.ScanRequest.Builder setVersion(long value)

uint64 version = 4;

clearVersion

public Kvrpcpb.ScanRequest.Builder clearVersion()

uint64 version = 4;

getKeyOnly

public boolean getKeyOnly()

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

bool key_only = 5;

指定者:

getKeyOnly 在接口中 Kvrpcpb.ScanRequestOrBuilder

setKeyOnly

public Kvrpcpb.ScanRequest.Builder setKeyOnly(boolean value)

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

bool key_only = 5;

clearKeyOnly

public Kvrpcpb.ScanRequest.Builder clearKeyOnly()

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

bool key_only = 5;

getReverse

public boolean getReverse()

bool reverse = 6;

指定者:

getReverse 在接口中 Kvrpcpb.ScanRequestOrBuilder

setReverse

public Kvrpcpb.ScanRequest.Builder setReverse(boolean value)

bool reverse = 6;

clearReverse

public Kvrpcpb.ScanRequest.Builder clearReverse()

bool reverse = 6;

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;

指定者:

getEndKey 在接口中 Kvrpcpb.ScanRequestOrBuilder

setEndKey

public Kvrpcpb.ScanRequest.Builder setEndKey(com.google.protobuf.ByteString value)

 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;

clearEndKey

public Kvrpcpb.ScanRequest.Builder clearEndKey()

 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;

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;

指定者:

getSampleStep 在接口中 Kvrpcpb.ScanRequestOrBuilder

setSampleStep

public Kvrpcpb.ScanRequest.Builder setSampleStep(int value)

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

uint32 sample_step = 8;

clearSampleStep

public Kvrpcpb.ScanRequest.Builder clearSampleStep()

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

uint32 sample_step = 8;

setUnknownFields

public final Kvrpcpb.ScanRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

指定者:

setUnknownFields 在接口中 com.google.protobuf.Message.Builder

覆盖:

setUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

mergeUnknownFields

public final Kvrpcpb.ScanRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

指定者:

mergeUnknownFields 在接口中 com.google.protobuf.Message.Builder

覆盖:

mergeUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>