Kvrpcpb.ScanRequest.Builder (TiKV Java Client 3.3.4-SNAPSHOT API)

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

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Kvrpcpb.ScanRequestOrBuilder

Enclosing class:: 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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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;`

Methods inherited from class 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

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - 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.Builder<Kvrpcpb.ScanRequest.Builder>
  - clear
```
public Kvrpcpb.ScanRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - getDefaultInstanceForType
```
public Kvrpcpb.ScanRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Kvrpcpb.ScanRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Kvrpcpb.ScanRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Kvrpcpb.ScanRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - setField
```
public Kvrpcpb.ScanRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - clearField
```
public Kvrpcpb.ScanRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - clearOneof
```
public Kvrpcpb.ScanRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - setRepeatedField
```
public Kvrpcpb.ScanRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - addRepeatedField
```
public Kvrpcpb.ScanRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - mergeFrom
```
public Kvrpcpb.ScanRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Kvrpcpb.ScanRequest.Builder>
  - mergeFrom
```
public Kvrpcpb.ScanRequest.Builder mergeFrom(Kvrpcpb.ScanRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class 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
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Kvrpcpb.ScanRequest.Builder>
    
    Throws:
    
    IOException
  - 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.
  - 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;
    
    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.
  - setStartKey
```
public Kvrpcpb.ScanRequest.Builder setStartKey(com.google.protobuf.ByteString value)
```
    bytes start_key = 2;
    
    Parameters:
    
    value - The startKey to set.
    
    Returns:
    
    This builder for chaining.
  - clearStartKey
```
public Kvrpcpb.ScanRequest.Builder clearStartKey()
```
    bytes start_key = 2;
    
    Returns:
    
    This builder for chaining.
  - getLimit
```
public int getLimit()
```
```
 The maximum number of results to return.
 
```
    uint32 limit = 3;
    Specified by:
    
    getLimit in interface Kvrpcpb.ScanRequestOrBuilder
    
    Returns:
    
    The limit.
  - setLimit
```
public Kvrpcpb.ScanRequest.Builder setLimit(int value)
```
```
 The maximum number of results to return.
 
```
    uint32 limit = 3;
    Parameters:
    
    value - The limit to set.
    
    Returns:
    
    This builder for chaining.
  - clearLimit
```
public Kvrpcpb.ScanRequest.Builder clearLimit()
```
```
 The maximum number of results to return.
 
```
    uint32 limit = 3;
    Returns:
    
    This builder for chaining.
  - getVersion
```
public long getVersion()
```
    uint64 version = 4;
    
    Specified by:
    
    getVersion in interface Kvrpcpb.ScanRequestOrBuilder
    
    Returns:
    
    The version.
  - setVersion
```
public Kvrpcpb.ScanRequest.Builder setVersion(long value)
```
    uint64 version = 4;
    
    Parameters:
    
    value - The version to set.
    
    Returns:
    
    This builder for chaining.
  - clearVersion
```
public Kvrpcpb.ScanRequest.Builder clearVersion()
```
    uint64 version = 4;
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setKeyOnly
```
public Kvrpcpb.ScanRequest.Builder setKeyOnly(boolean value)
```
```
 Return only the keys found by scanning, not their values.
 
```
    bool key_only = 5;
    Parameters:
    
    value - The keyOnly to set.
    
    Returns:
    
    This builder for chaining.
  - clearKeyOnly
```
public Kvrpcpb.ScanRequest.Builder clearKeyOnly()
```
```
 Return only the keys found by scanning, not their values.
 
```
    bool key_only = 5;
    Returns:
    
    This builder for chaining.
  - getReverse
```
public boolean getReverse()
```
    bool reverse = 6;
    
    Specified by:
    
    getReverse in interface Kvrpcpb.ScanRequestOrBuilder
    
    Returns:
    
    The reverse.
  - setReverse
```
public Kvrpcpb.ScanRequest.Builder setReverse(boolean value)
```
    bool reverse = 6;
    
    Parameters:
    
    value - The reverse to set.
    
    Returns:
    
    This builder for chaining.
  - clearReverse
```
public Kvrpcpb.ScanRequest.Builder clearReverse()
```
    bool reverse = 6;
    
    Returns:
    
    This builder for chaining.
  - 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.
  - 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;
    Parameters:
    
    value - The endKey to set.
    
    Returns:
    
    This builder for chaining.
  - 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;
    Returns:
    
    This builder for chaining.
  - 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.
  - 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;
    Parameters:
    
    value - The sampleStep to set.
    
    Returns:
    
    This builder for chaining.
  - 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;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Kvrpcpb.ScanRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>
  - mergeUnknownFields
```
public final Kvrpcpb.ScanRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanRequest.Builder>

Class Kvrpcpb.ScanRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasContext

getContext

setContext

setContext

mergeContext

clearContext

getContextBuilder

getContextOrBuilder

getStartKey

setStartKey

clearStartKey

getLimit

setLimit

clearLimit

getVersion

setVersion

clearVersion

getKeyOnly

setKeyOnly

clearKeyOnly

getReverse

setReverse

clearReverse

getEndKey

setEndKey

clearEndKey

getSampleStep

setSampleStep

clearSampleStep

setUnknownFields

mergeUnknownFields