IndexScan.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<IndexScan.Builder>
    - - com.pingcap.tidb.tipb.IndexScan.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, IndexScanOrBuilder, Cloneable

Enclosing class:

IndexScan
```
public static final class IndexScan.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<IndexScan.Builder>
implements IndexScanOrBuilder
```
Protobuf type tipb.IndexScan

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexScan.Builder`	`addAllColumns(Iterable<? extends ColumnInfo> values)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`addColumns(ColumnInfo.Builder builderForValue)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`addColumns(ColumnInfo value)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`addColumns(int index, ColumnInfo.Builder builderForValue)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`addColumns(int index, ColumnInfo value)` `repeated .tipb.ColumnInfo columns = 3;`
`ColumnInfo.Builder`	`addColumnsBuilder()` `repeated .tipb.ColumnInfo columns = 3;`
`ColumnInfo.Builder`	`addColumnsBuilder(int index)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`IndexScan`	`build()`
`IndexScan`	`buildPartial()`
`IndexScan.Builder`	`clear()`
`IndexScan.Builder`	`clearColumns()` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`clearDesc()` `optional bool desc = 4 [(.gogoproto.nullable) = false];`
`IndexScan.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`IndexScan.Builder`	`clearIndexId()` `optional int64 index_id = 2 [(.gogoproto.nullable) = false];`
`IndexScan.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`IndexScan.Builder`	`clearTableId()` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`IndexScan.Builder`	`clearUnique()` check whether it is a unique index.
`IndexScan.Builder`	`clone()`
`ColumnInfo`	`getColumns(int index)` `repeated .tipb.ColumnInfo columns = 3;`
`ColumnInfo.Builder`	`getColumnsBuilder(int index)` `repeated .tipb.ColumnInfo columns = 3;`
`List<ColumnInfo.Builder>`	`getColumnsBuilderList()` `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;`
`IndexScan`	`getDefaultInstanceForType()`
`boolean`	`getDesc()` `optional bool desc = 4 [(.gogoproto.nullable) = false];`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getIndexId()` `optional int64 index_id = 2 [(.gogoproto.nullable) = false];`
`long`	`getTableId()` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`boolean`	`getUnique()` check whether it is a unique index.
`boolean`	`hasDesc()` `optional bool desc = 4 [(.gogoproto.nullable) = false];`
`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()`
`IndexScan.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`IndexScan.Builder`	`mergeFrom(IndexScan other)`
`IndexScan.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`IndexScan.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`IndexScan.Builder`	`removeColumns(int index)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`setColumns(int index, ColumnInfo.Builder builderForValue)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`setColumns(int index, ColumnInfo value)` `repeated .tipb.ColumnInfo columns = 3;`
`IndexScan.Builder`	`setDesc(boolean value)` `optional bool desc = 4 [(.gogoproto.nullable) = false];`
`IndexScan.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`IndexScan.Builder`	`setIndexId(long value)` `optional int64 index_id = 2 [(.gogoproto.nullable) = false];`
`IndexScan.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`IndexScan.Builder`	`setTableId(long value)` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`IndexScan.Builder`	`setUnique(boolean value)` check whether it is a unique index.
`IndexScan.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<IndexScan.Builder>
  - clear
```
public IndexScan.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<IndexScan.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<IndexScan.Builder>
  - getDefaultInstanceForType
```
public IndexScan getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public IndexScan build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public IndexScan buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public IndexScan.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<IndexScan.Builder>
  - setField
```
public IndexScan.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<IndexScan.Builder>
  - clearField
```
public IndexScan.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<IndexScan.Builder>
  - clearOneof
```
public IndexScan.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<IndexScan.Builder>
  - setRepeatedField
```
public IndexScan.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<IndexScan.Builder>
  - addRepeatedField
```
public IndexScan.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<IndexScan.Builder>
  - mergeFrom
```
public IndexScan.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<IndexScan.Builder>
  - mergeFrom
```
public IndexScan.Builder mergeFrom(IndexScan other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<IndexScan.Builder>
  - mergeFrom
```
public IndexScan.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<IndexScan.Builder>
    
    Throws:
    
    IOException
  - 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.
  - setTableId
```
public IndexScan.Builder setTableId(long value)
```
    optional int64 table_id = 1 [(.gogoproto.nullable) = false];
    
    Parameters:
    
    value - The tableId to set.
    
    Returns:
    
    This builder for chaining.
  - clearTableId
```
public IndexScan.Builder clearTableId()
```
    optional int64 table_id = 1 [(.gogoproto.nullable) = false];
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setIndexId
```
public IndexScan.Builder setIndexId(long value)
```
    optional int64 index_id = 2 [(.gogoproto.nullable) = false];
    
    Parameters:
    
    value - The indexId to set.
    
    Returns:
    
    This builder for chaining.
  - clearIndexId
```
public IndexScan.Builder clearIndexId()
```
    optional int64 index_id = 2 [(.gogoproto.nullable) = false];
    
    Returns:
    
    This builder for chaining.
  - getColumnsList
```
public List<ColumnInfo> getColumnsList()
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsList 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
  - setColumns
```
public IndexScan.Builder setColumns(int index,
                                    ColumnInfo value)
```
    repeated .tipb.ColumnInfo columns = 3;
  - setColumns
```
public IndexScan.Builder setColumns(int index,
                                    ColumnInfo.Builder builderForValue)
```
    repeated .tipb.ColumnInfo columns = 3;
  - addColumns
```
public IndexScan.Builder addColumns(ColumnInfo value)
```
    repeated .tipb.ColumnInfo columns = 3;
  - addColumns
```
public IndexScan.Builder addColumns(int index,
                                    ColumnInfo value)
```
    repeated .tipb.ColumnInfo columns = 3;
  - addColumns
```
public IndexScan.Builder addColumns(ColumnInfo.Builder builderForValue)
```
    repeated .tipb.ColumnInfo columns = 3;
  - addColumns
```
public IndexScan.Builder addColumns(int index,
                                    ColumnInfo.Builder builderForValue)
```
    repeated .tipb.ColumnInfo columns = 3;
  - addAllColumns
```
public IndexScan.Builder addAllColumns(Iterable<? extends ColumnInfo> values)
```
    repeated .tipb.ColumnInfo columns = 3;
  - clearColumns
```
public IndexScan.Builder clearColumns()
```
    repeated .tipb.ColumnInfo columns = 3;
  - removeColumns
```
public IndexScan.Builder removeColumns(int index)
```
    repeated .tipb.ColumnInfo columns = 3;
  - getColumnsBuilder
```
public ColumnInfo.Builder getColumnsBuilder(int index)
```
    repeated .tipb.ColumnInfo columns = 3;
  - getColumnsOrBuilder
```
public ColumnInfoOrBuilder getColumnsOrBuilder(int index)
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsOrBuilder in interface IndexScanOrBuilder
  - getColumnsOrBuilderList
```
public List<? extends ColumnInfoOrBuilder> getColumnsOrBuilderList()
```
    repeated .tipb.ColumnInfo columns = 3;
    
    Specified by:
    
    getColumnsOrBuilderList in interface IndexScanOrBuilder
  - addColumnsBuilder
```
public ColumnInfo.Builder addColumnsBuilder()
```
    repeated .tipb.ColumnInfo columns = 3;
  - addColumnsBuilder
```
public ColumnInfo.Builder addColumnsBuilder(int index)
```
    repeated .tipb.ColumnInfo columns = 3;
  - getColumnsBuilderList
```
public List<ColumnInfo.Builder> getColumnsBuilderList()
```
    repeated .tipb.ColumnInfo columns = 3;
  - 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.
  - setDesc
```
public IndexScan.Builder setDesc(boolean value)
```
    optional bool desc = 4 [(.gogoproto.nullable) = false];
    
    Parameters:
    
    value - The desc to set.
    
    Returns:
    
    This builder for chaining.
  - clearDesc
```
public IndexScan.Builder clearDesc()
```
    optional bool desc = 4 [(.gogoproto.nullable) = false];
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setUnique
```
public IndexScan.Builder setUnique(boolean value)
```
```
 check whether it is a unique index.
 
```
    optional bool unique = 5;
    Parameters:
    
    value - The unique to set.
    
    Returns:
    
    This builder for chaining.
  - clearUnique
```
public IndexScan.Builder clearUnique()
```
```
 check whether it is a unique index.
 
```
    optional bool unique = 5;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final IndexScan.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<IndexScan.Builder>
  - mergeUnknownFields
```
public final IndexScan.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<IndexScan.Builder>

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

hasTableId

getTableId

setTableId

clearTableId

hasIndexId

getIndexId

setIndexId

clearIndexId

getColumnsList

getColumnsCount

getColumns

setColumns

setColumns

addColumns

addColumns

addColumns

addColumns

addAllColumns

clearColumns

removeColumns

getColumnsBuilder

getColumnsOrBuilder

getColumnsOrBuilderList

addColumnsBuilder

addColumnsBuilder

getColumnsBuilderList

hasDesc

getDesc

setDesc

clearDesc

hasUnique

getUnique

setUnique

clearUnique

setUnknownFields

mergeUnknownFields