SampleCollector (TiKV Java Client 3.3.4-SNAPSHOT API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.pingcap.tidb.tipb.SampleCollector

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SampleCollectorOrBuilder, Serializable
```
public final class SampleCollector
extends com.google.protobuf.GeneratedMessageV3
implements SampleCollectorOrBuilder
```
```
 SampleCollector is used for collect samples and calculate the count and ndv of an column.
 
```
Protobuf type tipb.SampleCollector
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SampleCollector.Builder
SampleCollector is used for collect samples and calculate the count and ndv of an column.
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`SampleCollector.Builder` SampleCollector is used for collect samples and calculate the count and ndv of an column.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CM_SKETCH_FIELD_NUMBER`
`static int`	`COUNT_FIELD_NUMBER`
`static int`	`FM_SKETCH_FIELD_NUMBER`
`static int`	`NULL_COUNT_FIELD_NUMBER`
`static com.google.protobuf.Parser<SampleCollector>`	`PARSER` Deprecated.
`static int`	`SAMPLES_FIELD_NUMBER`
`static int`	`TOTAL_SIZE_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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`CMSketch`	`getCmSketch()` `optional .tipb.CMSketch cm_sketch = 5;`
`CMSketchOrBuilder`	`getCmSketchOrBuilder()` `optional .tipb.CMSketch cm_sketch = 5;`
`long`	`getCount()` `optional int64 count = 3 [(.gogoproto.nullable) = false];`
`static SampleCollector`	`getDefaultInstance()`
`SampleCollector`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`FMSketch`	`getFmSketch()` `optional .tipb.FMSketch fm_sketch = 4;`
`FMSketchOrBuilder`	`getFmSketchOrBuilder()` `optional .tipb.FMSketch fm_sketch = 4;`
`long`	`getNullCount()` `optional int64 null_count = 2 [(.gogoproto.nullable) = false];`
`com.google.protobuf.Parser<SampleCollector>`	`getParserForType()`
`com.google.protobuf.ByteString`	`getSamples(int index)` `repeated bytes samples = 1;`
`int`	`getSamplesCount()` `repeated bytes samples = 1;`
`List<com.google.protobuf.ByteString>`	`getSamplesList()` `repeated bytes samples = 1;`
`int`	`getSerializedSize()`
`long`	`getTotalSize()` `optional int64 total_size = 6;`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasCmSketch()` `optional .tipb.CMSketch cm_sketch = 5;`
`boolean`	`hasCount()` `optional int64 count = 3 [(.gogoproto.nullable) = false];`
`boolean`	`hasFmSketch()` `optional .tipb.FMSketch fm_sketch = 4;`
`int`	`hashCode()`
`boolean`	`hasNullCount()` `optional int64 null_count = 2 [(.gogoproto.nullable) = false];`
`boolean`	`hasTotalSize()` `optional int64 total_size = 6;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static SampleCollector.Builder`	`newBuilder()`
`static SampleCollector.Builder`	`newBuilder(SampleCollector prototype)`
`SampleCollector.Builder`	`newBuilderForType()`
`protected SampleCollector.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static SampleCollector`	`parseDelimitedFrom(InputStream input)`
`static SampleCollector`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SampleCollector`	`parseFrom(byte[] data)`
`static SampleCollector`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SampleCollector`	`parseFrom(ByteBuffer data)`
`static SampleCollector`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SampleCollector`	`parseFrom(com.google.protobuf.ByteString data)`
`static SampleCollector`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SampleCollector`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static SampleCollector`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SampleCollector`	`parseFrom(InputStream input)`
`static SampleCollector`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<SampleCollector>`	`parser()`
`SampleCollector.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
  - SAMPLES_FIELD_NUMBER
```
public static final int SAMPLES_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - NULL_COUNT_FIELD_NUMBER
```
public static final int NULL_COUNT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - COUNT_FIELD_NUMBER
```
public static final int COUNT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - FM_SKETCH_FIELD_NUMBER
```
public static final int FM_SKETCH_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CM_SKETCH_FIELD_NUMBER
```
public static final int CM_SKETCH_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - TOTAL_SIZE_FIELD_NUMBER
```
public static final int TOTAL_SIZE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PARSER
```
@Deprecated
public static final com.google.protobuf.Parser<SampleCollector> PARSER
```
    Deprecated.
- 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
  - getSamplesList
```
public List<com.google.protobuf.ByteString> getSamplesList()
```
    repeated bytes samples = 1;
    
    Specified by:
    
    getSamplesList in interface SampleCollectorOrBuilder
    
    Returns:
    
    A list containing the samples.
  - getSamplesCount
```
public int getSamplesCount()
```
    repeated bytes samples = 1;
    
    Specified by:
    
    getSamplesCount in interface SampleCollectorOrBuilder
    
    Returns:
    
    The count of samples.
  - getSamples
```
public com.google.protobuf.ByteString getSamples(int index)
```
    repeated bytes samples = 1;
    
    Specified by:
    
    getSamples in interface SampleCollectorOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The samples at the given index.
  - hasNullCount
```
public boolean hasNullCount()
```
    optional int64 null_count = 2 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    hasNullCount in interface SampleCollectorOrBuilder
    
    Returns:
    
    Whether the nullCount field is set.
  - getNullCount
```
public long getNullCount()
```
    optional int64 null_count = 2 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    getNullCount in interface SampleCollectorOrBuilder
    
    Returns:
    
    The nullCount.
  - hasCount
```
public boolean hasCount()
```
    optional int64 count = 3 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    hasCount in interface SampleCollectorOrBuilder
    
    Returns:
    
    Whether the count field is set.
  - getCount
```
public long getCount()
```
    optional int64 count = 3 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    getCount in interface SampleCollectorOrBuilder
    
    Returns:
    
    The count.
  - hasFmSketch
```
public boolean hasFmSketch()
```
    optional .tipb.FMSketch fm_sketch = 4;
    
    Specified by:
    
    hasFmSketch in interface SampleCollectorOrBuilder
    
    Returns:
    
    Whether the fmSketch field is set.
  - getFmSketch
```
public FMSketch getFmSketch()
```
    optional .tipb.FMSketch fm_sketch = 4;
    
    Specified by:
    
    getFmSketch in interface SampleCollectorOrBuilder
    
    Returns:
    
    The fmSketch.
  - getFmSketchOrBuilder
```
public FMSketchOrBuilder getFmSketchOrBuilder()
```
    optional .tipb.FMSketch fm_sketch = 4;
    
    Specified by:
    
    getFmSketchOrBuilder in interface SampleCollectorOrBuilder
  - hasCmSketch
```
public boolean hasCmSketch()
```
    optional .tipb.CMSketch cm_sketch = 5;
    
    Specified by:
    
    hasCmSketch in interface SampleCollectorOrBuilder
    
    Returns:
    
    Whether the cmSketch field is set.
  - getCmSketch
```
public CMSketch getCmSketch()
```
    optional .tipb.CMSketch cm_sketch = 5;
    
    Specified by:
    
    getCmSketch in interface SampleCollectorOrBuilder
    
    Returns:
    
    The cmSketch.
  - getCmSketchOrBuilder
```
public CMSketchOrBuilder getCmSketchOrBuilder()
```
    optional .tipb.CMSketch cm_sketch = 5;
    
    Specified by:
    
    getCmSketchOrBuilder in interface SampleCollectorOrBuilder
  - hasTotalSize
```
public boolean hasTotalSize()
```
    optional int64 total_size = 6;
    
    Specified by:
    
    hasTotalSize in interface SampleCollectorOrBuilder
    
    Returns:
    
    Whether the totalSize field is set.
  - getTotalSize
```
public long getTotalSize()
```
    optional int64 total_size = 6;
    
    Specified by:
    
    getTotalSize in interface SampleCollectorOrBuilder
    
    Returns:
    
    The totalSize.
  - 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 SampleCollector parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SampleCollector parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SampleCollector parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SampleCollector parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SampleCollector parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SampleCollector parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SampleCollector parseFrom(InputStream input)
                                 throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static SampleCollector parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static SampleCollector parseDelimitedFrom(InputStream input)
                                          throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static SampleCollector parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static SampleCollector parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static SampleCollector parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public SampleCollector.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static SampleCollector.Builder newBuilder()
```
  - newBuilder
```
public static SampleCollector.Builder newBuilder(SampleCollector prototype)
```
  - toBuilder
```
public SampleCollector.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected SampleCollector.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static SampleCollector getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<SampleCollector> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<SampleCollector> 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 SampleCollector getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class SampleCollector

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

SAMPLES_FIELD_NUMBER

NULL_COUNT_FIELD_NUMBER

COUNT_FIELD_NUMBER

FM_SKETCH_FIELD_NUMBER

CM_SKETCH_FIELD_NUMBER

TOTAL_SIZE_FIELD_NUMBER

PARSER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getSamplesList

getSamplesCount

getSamples

hasNullCount

getNullCount

hasCount

getCount

hasFmSketch

getFmSketch

getFmSketchOrBuilder

hasCmSketch

getCmSketch

getCmSketchOrBuilder

hasTotalSize

getTotalSize

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType