IndexScan (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.IndexScan

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, IndexScanOrBuilder, Serializable
```
public final class IndexScan
extends com.google.protobuf.GeneratedMessageV3
implements IndexScanOrBuilder
```
Protobuf type tipb.IndexScan

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IndexScan.Builder
Protobuf type tipb.IndexScan
- 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`	`IndexScan.Builder` Protobuf type `tipb.IndexScan`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COLUMNS_FIELD_NUMBER`
`static int`	`DESC_FIELD_NUMBER`
`static int`	`INDEX_ID_FIELD_NUMBER`
`static com.google.protobuf.Parser<IndexScan>`	`PARSER` Deprecated.
`static int`	`TABLE_ID_FIELD_NUMBER`
`static int`	`UNIQUE_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)`
`ColumnInfo`	`getColumns(int index)` `repeated .tipb.ColumnInfo columns = 3;`
`int`	`getColumnsCount()` `repeated .tipb.ColumnInfo columns = 3;`
`List<ColumnInfo>`	`getColumnsList()` `repeated .tipb.ColumnInfo columns = 3;`
`ColumnInfoOrBuilder`	`getColumnsOrBuilder(int index)` `repeated .tipb.ColumnInfo columns = 3;`
`List<? extends ColumnInfoOrBuilder>`	`getColumnsOrBuilderList()` `repeated .tipb.ColumnInfo columns = 3;`
`static IndexScan`	`getDefaultInstance()`
`IndexScan`	`getDefaultInstanceForType()`
`boolean`	`getDesc()` `optional bool desc = 4 [(.gogoproto.nullable) = false];`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`long`	`getIndexId()` `optional int64 index_id = 2 [(.gogoproto.nullable) = false];`
`com.google.protobuf.Parser<IndexScan>`	`getParserForType()`
`int`	`getSerializedSize()`
`long`	`getTableId()` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`boolean`	`getUnique()` check whether it is a unique index.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasDesc()` `optional bool desc = 4 [(.gogoproto.nullable) = false];`
`int`	`hashCode()`
`boolean`	`hasIndexId()` `optional int64 index_id = 2 [(.gogoproto.nullable) = false];`
`boolean`	`hasTableId()` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`boolean`	`hasUnique()` check whether it is a unique index.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static IndexScan.Builder`	`newBuilder()`
`static IndexScan.Builder`	`newBuilder(IndexScan prototype)`
`IndexScan.Builder`	`newBuilderForType()`
`protected IndexScan.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static IndexScan`	`parseDelimitedFrom(InputStream input)`
`static IndexScan`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IndexScan`	`parseFrom(byte[] data)`
`static IndexScan`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IndexScan`	`parseFrom(ByteBuffer data)`
`static IndexScan`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IndexScan`	`parseFrom(com.google.protobuf.ByteString data)`
`static IndexScan`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IndexScan`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static IndexScan`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static IndexScan`	`parseFrom(InputStream input)`
`static IndexScan`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<IndexScan>`	`parser()`
`IndexScan.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
  - TABLE_ID_FIELD_NUMBER
```
public static final int TABLE_ID_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - INDEX_ID_FIELD_NUMBER
```
public static final int INDEX_ID_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - COLUMNS_FIELD_NUMBER
```
public static final int COLUMNS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - DESC_FIELD_NUMBER
```
public static final int DESC_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - UNIQUE_FIELD_NUMBER
```
public static final int UNIQUE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PARSER
```
@Deprecated
public static final com.google.protobuf.Parser<IndexScan> 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
  - hasTableId
```
public boolean hasTableId()
```
    optional int64 table_id = 1 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    hasTableId in interface IndexScanOrBuilder
    
    Returns:
    
    Whether the tableId field is set.
  - getTableId
```
public long getTableId()
```
    optional int64 table_id = 1 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    getTableId in interface IndexScanOrBuilder
    
    Returns:
    
    The tableId.
  - hasIndexId
```
public boolean hasIndexId()
```
    optional int64 index_id = 2 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    hasIndexId in interface IndexScanOrBuilder
    
    Returns:
    
    Whether the indexId field is set.
  - getIndexId
```
public long getIndexId()
```
    optional int64 index_id = 2 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    getIndexId in interface IndexScanOrBuilder
    
    Returns:
    
    The indexId.
  - getColumnsList
```
public List<ColumnInfo> getColumnsList()
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsList in interface IndexScanOrBuilder
  - getColumnsOrBuilderList
```
public List<? extends ColumnInfoOrBuilder> getColumnsOrBuilderList()
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsOrBuilderList in interface IndexScanOrBuilder
  - getColumnsCount
```
public int getColumnsCount()
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsCount in interface IndexScanOrBuilder
  - getColumns
```
public ColumnInfo getColumns(int index)
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumns in interface IndexScanOrBuilder
  - getColumnsOrBuilder
```
public ColumnInfoOrBuilder getColumnsOrBuilder(int index)
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsOrBuilder in interface IndexScanOrBuilder
  - hasDesc
```
public boolean hasDesc()
```
    optional bool desc = 4 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    hasDesc in interface IndexScanOrBuilder
    
    Returns:
    
    Whether the desc field is set.
  - getDesc
```
public boolean getDesc()
```
    optional bool desc = 4 [(.gogoproto.nullable) = false];
    
    Specified by:
    
    getDesc in interface IndexScanOrBuilder
    
    Returns:
    
    The desc.
  - hasUnique
```
public boolean hasUnique()
```
```
 check whether it is a unique index.
 
```
    optional bool unique = 5;
    Specified by:
    
    hasUnique in interface IndexScanOrBuilder
    
    Returns:
    
    Whether the unique field is set.
  - getUnique
```
public boolean getUnique()
```
```
 check whether it is a unique index.
 
```
    optional bool unique = 5;
    Specified by:
    
    getUnique in interface IndexScanOrBuilder
    
    Returns:
    
    The unique.
  - 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 IndexScan parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static IndexScan parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static IndexScan parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static IndexScan parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static IndexScan parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static IndexScan parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static IndexScan parseFrom(InputStream input)
                           throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static IndexScan parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static IndexScan parseDelimitedFrom(InputStream input)
                                    throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static IndexScan parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static IndexScan parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static IndexScan parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public IndexScan.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static IndexScan.Builder newBuilder()
```
  - newBuilder
```
public static IndexScan.Builder newBuilder(IndexScan prototype)
```
  - toBuilder
```
public IndexScan.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected IndexScan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static IndexScan getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<IndexScan> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<IndexScan> 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 IndexScan getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class IndexScan

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

TABLE_ID_FIELD_NUMBER

INDEX_ID_FIELD_NUMBER

COLUMNS_FIELD_NUMBER

DESC_FIELD_NUMBER

UNIQUE_FIELD_NUMBER

PARSER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

hasTableId

getTableId

hasIndexId

getIndexId

getColumnsList

getColumnsOrBuilderList

getColumnsCount

getColumns

getColumnsOrBuilder

hasDesc

getDesc

hasUnique

getUnique

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