org.tikv.kvproto

Class Kvrpcpb.ScanDetailV2.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

org.tikv.kvproto.Kvrpcpb.ScanDetailV2.Builder

All Implemented Interfaces:

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

Enclosing class:

Kvrpcpb.ScanDetailV2

public static final class Kvrpcpb.ScanDetailV2.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.ScanDetailV2.Builder>
implements Kvrpcpb.ScanDetailV2OrBuilder

Protobuf type kvrpcpb.ScanDetailV2

Method Summary

Modifier and Type	Method and Description
Kvrpcpb.ScanDetailV2.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Kvrpcpb.ScanDetailV2	build()
Kvrpcpb.ScanDetailV2	buildPartial()
Kvrpcpb.ScanDetailV2.Builder	clear()
Kvrpcpb.ScanDetailV2.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Kvrpcpb.ScanDetailV2.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Kvrpcpb.ScanDetailV2.Builder	clearProcessedVersions() Number of user keys scanned from the storage.
Kvrpcpb.ScanDetailV2.Builder	clearProcessedVersionsSize() Number of bytes of user key-value pairs scanned from the storage, i.e.
Kvrpcpb.ScanDetailV2.Builder	clearRocksdbBlockCacheHitCount() Total number of RocksDB block cache hits.
Kvrpcpb.ScanDetailV2.Builder	clearRocksdbBlockReadByte() Total number of bytes from block reads.
Kvrpcpb.ScanDetailV2.Builder	clearRocksdbBlockReadCount() Total number of block reads (with IO).
Kvrpcpb.ScanDetailV2.Builder	clearRocksdbDeleteSkippedCount() Total number of deletes and single deletes skipped over during iteration, i.e.
Kvrpcpb.ScanDetailV2.Builder	clearRocksdbKeySkippedCount() Total number of internal keys skipped over during iteration.
Kvrpcpb.ScanDetailV2.Builder	clearTotalVersions() Approximate number of MVCC keys meet during scanning.
Kvrpcpb.ScanDetailV2.Builder	clone()
Kvrpcpb.ScanDetailV2	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getProcessedVersions() Number of user keys scanned from the storage.
long	getProcessedVersionsSize() Number of bytes of user key-value pairs scanned from the storage, i.e.
long	getRocksdbBlockCacheHitCount() Total number of RocksDB block cache hits.
long	getRocksdbBlockReadByte() Total number of bytes from block reads.
long	getRocksdbBlockReadCount() Total number of block reads (with IO).
long	getRocksdbDeleteSkippedCount() Total number of deletes and single deletes skipped over during iteration, i.e.
long	getRocksdbKeySkippedCount() Total number of internal keys skipped over during iteration.
long	getTotalVersions() Approximate number of MVCC keys meet during scanning.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Kvrpcpb.ScanDetailV2.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Kvrpcpb.ScanDetailV2.Builder	mergeFrom(Kvrpcpb.ScanDetailV2 other)
Kvrpcpb.ScanDetailV2.Builder	mergeFrom(com.google.protobuf.Message other)
Kvrpcpb.ScanDetailV2.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Kvrpcpb.ScanDetailV2.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Kvrpcpb.ScanDetailV2.Builder	setProcessedVersions(long value) Number of user keys scanned from the storage.
Kvrpcpb.ScanDetailV2.Builder	setProcessedVersionsSize(long value) Number of bytes of user key-value pairs scanned from the storage, i.e.
Kvrpcpb.ScanDetailV2.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Kvrpcpb.ScanDetailV2.Builder	setRocksdbBlockCacheHitCount(long value) Total number of RocksDB block cache hits.
Kvrpcpb.ScanDetailV2.Builder	setRocksdbBlockReadByte(long value) Total number of bytes from block reads.
Kvrpcpb.ScanDetailV2.Builder	setRocksdbBlockReadCount(long value) Total number of block reads (with IO).
Kvrpcpb.ScanDetailV2.Builder	setRocksdbDeleteSkippedCount(long value) Total number of deletes and single deletes skipped over during iteration, i.e.
Kvrpcpb.ScanDetailV2.Builder	setRocksdbKeySkippedCount(long value) Total number of internal keys skipped over during iteration.
Kvrpcpb.ScanDetailV2.Builder	setTotalVersions(long value) Approximate number of MVCC keys meet during scanning.
Kvrpcpb.ScanDetailV2.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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.ScanDetailV2.Builder>

clear

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.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.ScanDetailV2.Builder>

getDefaultInstanceForType

public Kvrpcpb.ScanDetailV2 getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Kvrpcpb.ScanDetailV2 build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Kvrpcpb.ScanDetailV2 buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

setField

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

clearField

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

clearOneof

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

setRepeatedField

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

addRepeatedField

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

mergeFrom

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

mergeFrom

public Kvrpcpb.ScanDetailV2.Builder mergeFrom(Kvrpcpb.ScanDetailV2 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.ScanDetailV2.Builder>

mergeFrom

public Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

Throws:

IOException

getProcessedVersions

public long getProcessedVersions()

 Number of user keys scanned from the storage.
 It does not include deleted version or RocksDB tombstone keys.
 For Coprocessor requests, it includes keys that has been filtered out by
 Selection.
 

uint64 processed_versions = 1;

Specified by:

getProcessedVersions in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The processedVersions.

setProcessedVersions

public Kvrpcpb.ScanDetailV2.Builder setProcessedVersions(long value)

 Number of user keys scanned from the storage.
 It does not include deleted version or RocksDB tombstone keys.
 For Coprocessor requests, it includes keys that has been filtered out by
 Selection.
 

uint64 processed_versions = 1;

Parameters:

value - The processedVersions to set.

Returns:

This builder for chaining.

clearProcessedVersions

public Kvrpcpb.ScanDetailV2.Builder clearProcessedVersions()

 Number of user keys scanned from the storage.
 It does not include deleted version or RocksDB tombstone keys.
 For Coprocessor requests, it includes keys that has been filtered out by
 Selection.
 

uint64 processed_versions = 1;

Returns:

This builder for chaining.

getProcessedVersionsSize

public long getProcessedVersionsSize()

 Number of bytes of user key-value pairs scanned from the storage, i.e.
 total size of data returned from MVCC layer.
 

uint64 processed_versions_size = 8;

Specified by:

getProcessedVersionsSize in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The processedVersionsSize.

setProcessedVersionsSize

public Kvrpcpb.ScanDetailV2.Builder setProcessedVersionsSize(long value)

 Number of bytes of user key-value pairs scanned from the storage, i.e.
 total size of data returned from MVCC layer.
 

uint64 processed_versions_size = 8;

Parameters:

value - The processedVersionsSize to set.

Returns:

This builder for chaining.

clearProcessedVersionsSize

public Kvrpcpb.ScanDetailV2.Builder clearProcessedVersionsSize()

 Number of bytes of user key-value pairs scanned from the storage, i.e.
 total size of data returned from MVCC layer.
 

uint64 processed_versions_size = 8;

Returns:

This builder for chaining.

getTotalVersions

public long getTotalVersions()

 Approximate number of MVCC keys meet during scanning. It includes
 deleted versions, but does not include RocksDB tombstone keys.
 When this field is notably larger than `processed_versions`, it means
 there are a lot of deleted MVCC keys.
 

uint64 total_versions = 2;

Specified by:

getTotalVersions in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The totalVersions.

setTotalVersions

public Kvrpcpb.ScanDetailV2.Builder setTotalVersions(long value)

 Approximate number of MVCC keys meet during scanning. It includes
 deleted versions, but does not include RocksDB tombstone keys.
 When this field is notably larger than `processed_versions`, it means
 there are a lot of deleted MVCC keys.
 

uint64 total_versions = 2;

Parameters:

value - The totalVersions to set.

Returns:

This builder for chaining.

clearTotalVersions

public Kvrpcpb.ScanDetailV2.Builder clearTotalVersions()

 Approximate number of MVCC keys meet during scanning. It includes
 deleted versions, but does not include RocksDB tombstone keys.
 When this field is notably larger than `processed_versions`, it means
 there are a lot of deleted MVCC keys.
 

uint64 total_versions = 2;

Returns:

This builder for chaining.

getRocksdbDeleteSkippedCount

public long getRocksdbDeleteSkippedCount()

 Total number of deletes and single deletes skipped over during
 iteration, i.e. how many RocksDB tombstones are skipped.
 

uint64 rocksdb_delete_skipped_count = 3;

Specified by:

getRocksdbDeleteSkippedCount in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The rocksdbDeleteSkippedCount.

setRocksdbDeleteSkippedCount

public Kvrpcpb.ScanDetailV2.Builder setRocksdbDeleteSkippedCount(long value)

 Total number of deletes and single deletes skipped over during
 iteration, i.e. how many RocksDB tombstones are skipped.
 

uint64 rocksdb_delete_skipped_count = 3;

Parameters:

value - The rocksdbDeleteSkippedCount to set.

Returns:

This builder for chaining.

clearRocksdbDeleteSkippedCount

public Kvrpcpb.ScanDetailV2.Builder clearRocksdbDeleteSkippedCount()

 Total number of deletes and single deletes skipped over during
 iteration, i.e. how many RocksDB tombstones are skipped.
 

uint64 rocksdb_delete_skipped_count = 3;

Returns:

This builder for chaining.

getRocksdbKeySkippedCount

public long getRocksdbKeySkippedCount()

 Total number of internal keys skipped over during iteration.
 See https://github.com/facebook/rocksdb/blob/9f1c84ca471d8b1ad7be9f3eebfc2c7e07dfd7a7/include/rocksdb/perf_context.h#L84 for details.
 

uint64 rocksdb_key_skipped_count = 4;

Specified by:

getRocksdbKeySkippedCount in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The rocksdbKeySkippedCount.

setRocksdbKeySkippedCount

public Kvrpcpb.ScanDetailV2.Builder setRocksdbKeySkippedCount(long value)

 Total number of internal keys skipped over during iteration.
 See https://github.com/facebook/rocksdb/blob/9f1c84ca471d8b1ad7be9f3eebfc2c7e07dfd7a7/include/rocksdb/perf_context.h#L84 for details.
 

uint64 rocksdb_key_skipped_count = 4;

Parameters:

value - The rocksdbKeySkippedCount to set.

Returns:

This builder for chaining.

clearRocksdbKeySkippedCount

public Kvrpcpb.ScanDetailV2.Builder clearRocksdbKeySkippedCount()

 Total number of internal keys skipped over during iteration.
 See https://github.com/facebook/rocksdb/blob/9f1c84ca471d8b1ad7be9f3eebfc2c7e07dfd7a7/include/rocksdb/perf_context.h#L84 for details.
 

uint64 rocksdb_key_skipped_count = 4;

Returns:

This builder for chaining.

getRocksdbBlockCacheHitCount

public long getRocksdbBlockCacheHitCount()

 Total number of RocksDB block cache hits.
 

uint64 rocksdb_block_cache_hit_count = 5;

Specified by:

getRocksdbBlockCacheHitCount in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The rocksdbBlockCacheHitCount.

setRocksdbBlockCacheHitCount

public Kvrpcpb.ScanDetailV2.Builder setRocksdbBlockCacheHitCount(long value)

 Total number of RocksDB block cache hits.
 

uint64 rocksdb_block_cache_hit_count = 5;

Parameters:

value - The rocksdbBlockCacheHitCount to set.

Returns:

This builder for chaining.

clearRocksdbBlockCacheHitCount

public Kvrpcpb.ScanDetailV2.Builder clearRocksdbBlockCacheHitCount()

 Total number of RocksDB block cache hits.
 

uint64 rocksdb_block_cache_hit_count = 5;

Returns:

This builder for chaining.

getRocksdbBlockReadCount

public long getRocksdbBlockReadCount()

 Total number of block reads (with IO).
 

uint64 rocksdb_block_read_count = 6;

Specified by:

getRocksdbBlockReadCount in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The rocksdbBlockReadCount.

setRocksdbBlockReadCount

public Kvrpcpb.ScanDetailV2.Builder setRocksdbBlockReadCount(long value)

 Total number of block reads (with IO).
 

uint64 rocksdb_block_read_count = 6;

Parameters:

value - The rocksdbBlockReadCount to set.

Returns:

This builder for chaining.

clearRocksdbBlockReadCount

public Kvrpcpb.ScanDetailV2.Builder clearRocksdbBlockReadCount()

 Total number of block reads (with IO).
 

uint64 rocksdb_block_read_count = 6;

Returns:

This builder for chaining.

getRocksdbBlockReadByte

public long getRocksdbBlockReadByte()

 Total number of bytes from block reads.
 

uint64 rocksdb_block_read_byte = 7;

Specified by:

getRocksdbBlockReadByte in interface Kvrpcpb.ScanDetailV2OrBuilder

Returns:

The rocksdbBlockReadByte.

setRocksdbBlockReadByte

public Kvrpcpb.ScanDetailV2.Builder setRocksdbBlockReadByte(long value)

 Total number of bytes from block reads.
 

uint64 rocksdb_block_read_byte = 7;

Parameters:

value - The rocksdbBlockReadByte to set.

Returns:

This builder for chaining.

clearRocksdbBlockReadByte

public Kvrpcpb.ScanDetailV2.Builder clearRocksdbBlockReadByte()

 Total number of bytes from block reads.
 

uint64 rocksdb_block_read_byte = 7;

Returns:

This builder for chaining.

setUnknownFields

public final Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>

mergeUnknownFields

public final Kvrpcpb.ScanDetailV2.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.ScanDetailV2.Builder>