ClientProtos.ScanOrBuilder (Apache HBase 2.1.0-cdh6.3.2 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ClientProtos.Scan, ClientProtos.Scan.Builder

Enclosing class:

ClientProtos
```
public static interface ClientProtos.ScanOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`getAllowPartialResults()` `optional bool allow_partial_results = 18;`
`HBaseProtos.NameBytesPair`	`getAttribute(int index)` `repeated .hbase.pb.NameBytesPair attribute = 2;`
`int`	`getAttributeCount()` `repeated .hbase.pb.NameBytesPair attribute = 2;`
`List<HBaseProtos.NameBytesPair>`	`getAttributeList()` `repeated .hbase.pb.NameBytesPair attribute = 2;`
`HBaseProtos.NameBytesPairOrBuilder`	`getAttributeOrBuilder(int index)` `repeated .hbase.pb.NameBytesPair attribute = 2;`
`List<? extends HBaseProtos.NameBytesPairOrBuilder>`	`getAttributeOrBuilderList()` `repeated .hbase.pb.NameBytesPair attribute = 2;`
`int`	`getBatchSize()` `optional uint32 batch_size = 9;`
`boolean`	`getCacheBlocks()` `optional bool cache_blocks = 8 [default = true];`
`int`	`getCaching()` `optional uint32 caching = 17;`
`HBaseProtos.ColumnFamilyTimeRange`	`getCfTimeRange(int index)` `repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;`
`int`	`getCfTimeRangeCount()` `repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;`
`List<HBaseProtos.ColumnFamilyTimeRange>`	`getCfTimeRangeList()` `repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;`
`HBaseProtos.ColumnFamilyTimeRangeOrBuilder`	`getCfTimeRangeOrBuilder(int index)` `repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;`
`List<? extends HBaseProtos.ColumnFamilyTimeRangeOrBuilder>`	`getCfTimeRangeOrBuilderList()` `repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;`
`ClientProtos.Column`	`getColumn(int index)` `repeated .hbase.pb.Column column = 1;`
`int`	`getColumnCount()` `repeated .hbase.pb.Column column = 1;`
`List<ClientProtos.Column>`	`getColumnList()` `repeated .hbase.pb.Column column = 1;`
`ClientProtos.ColumnOrBuilder`	`getColumnOrBuilder(int index)` `repeated .hbase.pb.Column column = 1;`
`List<? extends ClientProtos.ColumnOrBuilder>`	`getColumnOrBuilderList()` `repeated .hbase.pb.Column column = 1;`
`ClientProtos.Consistency`	`getConsistency()` `optional .hbase.pb.Consistency consistency = 16 [default = STRONG];`
`FilterProtos.Filter`	`getFilter()` `optional .hbase.pb.Filter filter = 5;`
`FilterProtos.FilterOrBuilder`	`getFilterOrBuilder()` `optional .hbase.pb.Filter filter = 5;`
`boolean`	`getIncludeStartRow()` `optional bool include_start_row = 21 [default = true];`
`boolean`	`getIncludeStopRow()` `optional bool include_stop_row = 22 [default = false];`
`boolean`	`getLoadColumnFamiliesOnDemand()` `optional bool load_column_families_on_demand = 13;`
`long`	`getMaxResultSize()` `optional uint64 max_result_size = 10;`
`int`	`getMaxVersions()` `optional uint32 max_versions = 7 [default = 1];`
`long`	`getMvccReadPoint()` `optional uint64 mvcc_read_point = 20 [default = 0];`
`boolean`	`getNeedCursorResult()` `optional bool need_cursor_result = 24 [default = false];`
`ClientProtos.Scan.ReadType`	`getReadType()` `optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];`
`boolean`	`getReversed()` `optional bool reversed = 15 [default = false];`
`boolean`	`getSmall()` Deprecated.
`com.google.protobuf.ByteString`	`getStartRow()` `optional bytes start_row = 3;`
`com.google.protobuf.ByteString`	`getStopRow()` `optional bytes stop_row = 4;`
`int`	`getStoreLimit()` `optional uint32 store_limit = 11;`
`int`	`getStoreOffset()` `optional uint32 store_offset = 12;`
`HBaseProtos.TimeRange`	`getTimeRange()` `optional .hbase.pb.TimeRange time_range = 6;`
`HBaseProtos.TimeRangeOrBuilder`	`getTimeRangeOrBuilder()` `optional .hbase.pb.TimeRange time_range = 6;`
`boolean`	`hasAllowPartialResults()` `optional bool allow_partial_results = 18;`
`boolean`	`hasBatchSize()` `optional uint32 batch_size = 9;`
`boolean`	`hasCacheBlocks()` `optional bool cache_blocks = 8 [default = true];`
`boolean`	`hasCaching()` `optional uint32 caching = 17;`
`boolean`	`hasConsistency()` `optional .hbase.pb.Consistency consistency = 16 [default = STRONG];`
`boolean`	`hasFilter()` `optional .hbase.pb.Filter filter = 5;`
`boolean`	`hasIncludeStartRow()` `optional bool include_start_row = 21 [default = true];`
`boolean`	`hasIncludeStopRow()` `optional bool include_stop_row = 22 [default = false];`
`boolean`	`hasLoadColumnFamiliesOnDemand()` `optional bool load_column_families_on_demand = 13;`
`boolean`	`hasMaxResultSize()` `optional uint64 max_result_size = 10;`
`boolean`	`hasMaxVersions()` `optional uint32 max_versions = 7 [default = 1];`
`boolean`	`hasMvccReadPoint()` `optional uint64 mvcc_read_point = 20 [default = 0];`
`boolean`	`hasNeedCursorResult()` `optional bool need_cursor_result = 24 [default = false];`
`boolean`	`hasReadType()` `optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];`
`boolean`	`hasReversed()` `optional bool reversed = 15 [default = false];`
`boolean`	`hasSmall()` Deprecated.
`boolean`	`hasStartRow()` `optional bytes start_row = 3;`
`boolean`	`hasStopRow()` `optional bytes stop_row = 4;`
`boolean`	`hasStoreLimit()` `optional uint32 store_limit = 11;`
`boolean`	`hasStoreOffset()` `optional uint32 store_offset = 12;`
`boolean`	`hasTimeRange()` `optional .hbase.pb.TimeRange time_range = 6;`

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - getColumnList
```
List<ClientProtos.Column> getColumnList()
```
    repeated .hbase.pb.Column column = 1;
  - getColumn
```
ClientProtos.Column getColumn(int index)
```
    repeated .hbase.pb.Column column = 1;
  - getColumnCount
```
int getColumnCount()
```
    repeated .hbase.pb.Column column = 1;
  - getColumnOrBuilderList
```
List<? extends ClientProtos.ColumnOrBuilder> getColumnOrBuilderList()
```
    repeated .hbase.pb.Column column = 1;
  - getColumnOrBuilder
```
ClientProtos.ColumnOrBuilder getColumnOrBuilder(int index)
```
    repeated .hbase.pb.Column column = 1;
  - getAttributeList
```
List<HBaseProtos.NameBytesPair> getAttributeList()
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
  - getAttribute
```
HBaseProtos.NameBytesPair getAttribute(int index)
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
  - getAttributeCount
```
int getAttributeCount()
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
  - getAttributeOrBuilderList
```
List<? extends HBaseProtos.NameBytesPairOrBuilder> getAttributeOrBuilderList()
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
  - getAttributeOrBuilder
```
HBaseProtos.NameBytesPairOrBuilder getAttributeOrBuilder(int index)
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
  - hasStartRow
```
boolean hasStartRow()
```
    optional bytes start_row = 3;
  - getStartRow
```
com.google.protobuf.ByteString getStartRow()
```
    optional bytes start_row = 3;
  - hasStopRow
```
boolean hasStopRow()
```
    optional bytes stop_row = 4;
  - getStopRow
```
com.google.protobuf.ByteString getStopRow()
```
    optional bytes stop_row = 4;
  - hasFilter
```
boolean hasFilter()
```
    optional .hbase.pb.Filter filter = 5;
  - getFilter
```
FilterProtos.Filter getFilter()
```
    optional .hbase.pb.Filter filter = 5;
  - getFilterOrBuilder
```
FilterProtos.FilterOrBuilder getFilterOrBuilder()
```
    optional .hbase.pb.Filter filter = 5;
  - hasTimeRange
```
boolean hasTimeRange()
```
    optional .hbase.pb.TimeRange time_range = 6;
  - getTimeRange
```
HBaseProtos.TimeRange getTimeRange()
```
    optional .hbase.pb.TimeRange time_range = 6;
  - getTimeRangeOrBuilder
```
HBaseProtos.TimeRangeOrBuilder getTimeRangeOrBuilder()
```
    optional .hbase.pb.TimeRange time_range = 6;
  - hasMaxVersions
```
boolean hasMaxVersions()
```
    optional uint32 max_versions = 7 [default = 1];
  - getMaxVersions
```
int getMaxVersions()
```
    optional uint32 max_versions = 7 [default = 1];
  - hasCacheBlocks
```
boolean hasCacheBlocks()
```
    optional bool cache_blocks = 8 [default = true];
  - getCacheBlocks
```
boolean getCacheBlocks()
```
    optional bool cache_blocks = 8 [default = true];
  - hasBatchSize
```
boolean hasBatchSize()
```
    optional uint32 batch_size = 9;
  - getBatchSize
```
int getBatchSize()
```
    optional uint32 batch_size = 9;
  - hasMaxResultSize
```
boolean hasMaxResultSize()
```
    optional uint64 max_result_size = 10;
  - getMaxResultSize
```
long getMaxResultSize()
```
    optional uint64 max_result_size = 10;
  - hasStoreLimit
```
boolean hasStoreLimit()
```
    optional uint32 store_limit = 11;
  - getStoreLimit
```
int getStoreLimit()
```
    optional uint32 store_limit = 11;
  - hasStoreOffset
```
boolean hasStoreOffset()
```
    optional uint32 store_offset = 12;
  - getStoreOffset
```
int getStoreOffset()
```
    optional uint32 store_offset = 12;
  - hasLoadColumnFamiliesOnDemand
```
boolean hasLoadColumnFamiliesOnDemand()
```
    optional bool load_column_families_on_demand = 13;
```
 DO NOT add defaults to load_column_families_on_demand. 
 
```
  - getLoadColumnFamiliesOnDemand
```
boolean getLoadColumnFamiliesOnDemand()
```
    optional bool load_column_families_on_demand = 13;
```
 DO NOT add defaults to load_column_families_on_demand. 
 
```
  - hasSmall
```
@Deprecated
boolean hasSmall()
```
    Deprecated.
    
    optional bool small = 14 [deprecated = true];
  - getSmall
```
@Deprecated
boolean getSmall()
```
    Deprecated.
    
    optional bool small = 14 [deprecated = true];
  - hasReversed
```
boolean hasReversed()
```
    optional bool reversed = 15 [default = false];
  - getReversed
```
boolean getReversed()
```
    optional bool reversed = 15 [default = false];
  - hasConsistency
```
boolean hasConsistency()
```
    optional .hbase.pb.Consistency consistency = 16 [default = STRONG];
  - getConsistency
```
ClientProtos.Consistency getConsistency()
```
    optional .hbase.pb.Consistency consistency = 16 [default = STRONG];
  - hasCaching
```
boolean hasCaching()
```
    optional uint32 caching = 17;
  - getCaching
```
int getCaching()
```
    optional uint32 caching = 17;
  - hasAllowPartialResults
```
boolean hasAllowPartialResults()
```
    optional bool allow_partial_results = 18;
  - getAllowPartialResults
```
boolean getAllowPartialResults()
```
    optional bool allow_partial_results = 18;
  - getCfTimeRangeList
```
List<HBaseProtos.ColumnFamilyTimeRange> getCfTimeRangeList()
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
  - getCfTimeRange
```
HBaseProtos.ColumnFamilyTimeRange getCfTimeRange(int index)
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
  - getCfTimeRangeCount
```
int getCfTimeRangeCount()
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
  - getCfTimeRangeOrBuilderList
```
List<? extends HBaseProtos.ColumnFamilyTimeRangeOrBuilder> getCfTimeRangeOrBuilderList()
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
  - getCfTimeRangeOrBuilder
```
HBaseProtos.ColumnFamilyTimeRangeOrBuilder getCfTimeRangeOrBuilder(int index)
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
  - hasMvccReadPoint
```
boolean hasMvccReadPoint()
```
    optional uint64 mvcc_read_point = 20 [default = 0];
  - getMvccReadPoint
```
long getMvccReadPoint()
```
    optional uint64 mvcc_read_point = 20 [default = 0];
  - hasIncludeStartRow
```
boolean hasIncludeStartRow()
```
    optional bool include_start_row = 21 [default = true];
  - getIncludeStartRow
```
boolean getIncludeStartRow()
```
    optional bool include_start_row = 21 [default = true];
  - hasIncludeStopRow
```
boolean hasIncludeStopRow()
```
    optional bool include_stop_row = 22 [default = false];
  - getIncludeStopRow
```
boolean getIncludeStopRow()
```
    optional bool include_stop_row = 22 [default = false];
  - hasReadType
```
boolean hasReadType()
```
    optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];
  - getReadType
```
ClientProtos.Scan.ReadType getReadType()
```
    optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];
  - hasNeedCursorResult
```
boolean hasNeedCursorResult()
```
    optional bool need_cursor_result = 24 [default = false];
  - getNeedCursorResult
```
boolean getNeedCursorResult()
```
    optional bool need_cursor_result = 24 [default = false];

Interface ClientProtos.ScanOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

getColumnList

getColumn

getColumnCount

getColumnOrBuilderList

getColumnOrBuilder

getAttributeList

getAttribute

getAttributeCount

getAttributeOrBuilderList

getAttributeOrBuilder

hasStartRow

getStartRow

hasStopRow

getStopRow

hasFilter

getFilter

getFilterOrBuilder

hasTimeRange

getTimeRange

getTimeRangeOrBuilder

hasMaxVersions

getMaxVersions

hasCacheBlocks

getCacheBlocks

hasBatchSize

getBatchSize

hasMaxResultSize

getMaxResultSize

hasStoreLimit

getStoreLimit

hasStoreOffset

getStoreOffset

hasLoadColumnFamiliesOnDemand

getLoadColumnFamiliesOnDemand

hasSmall

getSmall

hasReversed

getReversed

hasConsistency

getConsistency

hasCaching

getCaching

hasAllowPartialResults

getAllowPartialResults

getCfTimeRangeList

getCfTimeRange

getCfTimeRangeCount

getCfTimeRangeOrBuilderList

getCfTimeRangeOrBuilder

hasMvccReadPoint

getMvccReadPoint

hasIncludeStartRow

getIncludeStartRow

hasIncludeStopRow

getIncludeStopRow

hasReadType

getReadType

hasNeedCursorResult

getNeedCursorResult