ClientProtos.Scan (Apache HBase 2.1.0-cdh6.x-SNAPSHOT API)

java.lang.Object
- org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessageLite
- - org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage
  - - org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
    - - org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Scan

All Implemented Interfaces:: Serializable, ClientProtos.ScanOrBuilder, org.apache.hbase.thirdparty.com.google.protobuf.Message, org.apache.hbase.thirdparty.com.google.protobuf.MessageLite, org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder, org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

Enclosing class:: ClientProtos

public static final class ClientProtos.Scan
extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
implements ClientProtos.ScanOrBuilder


 Instead of get from a table, you can scan it with optional filters.
 You can specify the row key range, time range, the columns/families
 to scan and so on.
 This scan is used the first time in a scan request. The response of
 the initial scan will return a scanner id, which should be used to
 fetch result batches later on before it is closed.

Protobuf type hbase.pb.Scan

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClientProtos.Scan.Builder` Instead of get from a table, you can scan it with optional filters.
`static class`	`ClientProtos.Scan.ReadType` Protobuf enum `hbase.pb.Scan.ReadType`

Nested classes/interfaces inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.BuilderParent, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOW_PARTIAL_RESULTS_FIELD_NUMBER`
`static int`	`ATTRIBUTE_FIELD_NUMBER`
`static int`	`BATCH_SIZE_FIELD_NUMBER`
`static int`	`CACHE_BLOCKS_FIELD_NUMBER`
`static int`	`CACHING_FIELD_NUMBER`
`static int`	`CF_TIME_RANGE_FIELD_NUMBER`
`static int`	`COLUMN_FIELD_NUMBER`
`static int`	`CONSISTENCY_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`INCLUDE_START_ROW_FIELD_NUMBER`
`static int`	`INCLUDE_STOP_ROW_FIELD_NUMBER`
`static int`	`LOAD_COLUMN_FAMILIES_ON_DEMAND_FIELD_NUMBER`
`static int`	`MAX_RESULT_SIZE_FIELD_NUMBER`
`static int`	`MAX_VERSIONS_FIELD_NUMBER`
`static int`	`MVCC_READ_POINT_FIELD_NUMBER`
`static int`	`NEED_CURSOR_RESULT_FIELD_NUMBER`
`static org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.Scan>`	`PARSER` Deprecated.
`static int`	`READTYPE_FIELD_NUMBER`
`static int`	`REVERSED_FIELD_NUMBER`
`static int`	`SMALL_FIELD_NUMBER`
`static int`	`START_ROW_FIELD_NUMBER`
`static int`	`STOP_ROW_FIELD_NUMBER`
`static int`	`STORE_LIMIT_FIELD_NUMBER`
`static int`	`STORE_OFFSET_FIELD_NUMBER`
`static int`	`TIME_RANGE_FIELD_NUMBER`

Fields inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`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];`
`static ClientProtos.Scan`	`getDefaultInstance()`
`ClientProtos.Scan`	`getDefaultInstanceForType()`
`static org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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()` DO NOT add defaults to load_column_families_on_demand.
`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];`
`org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.Scan>`	`getParserForType()`
`ClientProtos.Scan.ReadType`	`getReadType()` `optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];`
`boolean`	`getReversed()` `optional bool reversed = 15 [default = false];`
`int`	`getSerializedSize()`
`boolean`	`getSmall()` Deprecated.
`org.apache.hbase.thirdparty.com.google.protobuf.ByteString`	`getStartRow()` `optional bytes start_row = 3;`
`org.apache.hbase.thirdparty.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;`
`org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`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;`
`int`	`hashCode()`
`boolean`	`hasIncludeStartRow()` `optional bool include_start_row = 21 [default = true];`
`boolean`	`hasIncludeStopRow()` `optional bool include_stop_row = 22 [default = false];`
`boolean`	`hasLoadColumnFamiliesOnDemand()` DO NOT add defaults to load_column_families_on_demand.
`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;`
`protected org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static ClientProtos.Scan.Builder`	`newBuilder()`
`static ClientProtos.Scan.Builder`	`newBuilder(ClientProtos.Scan prototype)`
`ClientProtos.Scan.Builder`	`newBuilderForType()`
`protected ClientProtos.Scan.Builder`	`newBuilderForType(org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static ClientProtos.Scan`	`parseDelimitedFrom(InputStream input)`
`static ClientProtos.Scan`	`parseDelimitedFrom(InputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClientProtos.Scan`	`parseFrom(byte[] data)`
`static ClientProtos.Scan`	`parseFrom(byte[] data, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClientProtos.Scan`	`parseFrom(ByteBuffer data)`
`static ClientProtos.Scan`	`parseFrom(ByteBuffer data, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClientProtos.Scan`	`parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data)`
`static ClientProtos.Scan`	`parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClientProtos.Scan`	`parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input)`
`static ClientProtos.Scan`	`parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClientProtos.Scan`	`parseFrom(InputStream input)`
`static ClientProtos.Scan`	`parseFrom(InputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.Scan>`	`parser()`
`ClientProtos.Scan.Builder`	`toBuilder()`
`void`	`writeTo(org.apache.hbase.thirdparty.com.google.protobuf.CodedOutputStream output)`

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class org.apache.hbase.thirdparty.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 org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - COLUMN_FIELD_NUMBER
```
public static final int COLUMN_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_FIELD_NUMBER
```
public static final int ATTRIBUTE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - START_ROW_FIELD_NUMBER
```
public static final int START_ROW_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - STOP_ROW_FIELD_NUMBER
```
public static final int STOP_ROW_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - TIME_RANGE_FIELD_NUMBER
```
public static final int TIME_RANGE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAX_VERSIONS_FIELD_NUMBER
```
public static final int MAX_VERSIONS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CACHE_BLOCKS_FIELD_NUMBER
```
public static final int CACHE_BLOCKS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - BATCH_SIZE_FIELD_NUMBER
```
public static final int BATCH_SIZE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAX_RESULT_SIZE_FIELD_NUMBER
```
public static final int MAX_RESULT_SIZE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - STORE_LIMIT_FIELD_NUMBER
```
public static final int STORE_LIMIT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - STORE_OFFSET_FIELD_NUMBER
```
public static final int STORE_OFFSET_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - LOAD_COLUMN_FAMILIES_ON_DEMAND_FIELD_NUMBER
```
public static final int LOAD_COLUMN_FAMILIES_ON_DEMAND_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SMALL_FIELD_NUMBER
```
public static final int SMALL_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - REVERSED_FIELD_NUMBER
```
public static final int REVERSED_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CONSISTENCY_FIELD_NUMBER
```
public static final int CONSISTENCY_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CACHING_FIELD_NUMBER
```
public static final int CACHING_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ALLOW_PARTIAL_RESULTS_FIELD_NUMBER
```
public static final int ALLOW_PARTIAL_RESULTS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CF_TIME_RANGE_FIELD_NUMBER
```
public static final int CF_TIME_RANGE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MVCC_READ_POINT_FIELD_NUMBER
```
public static final int MVCC_READ_POINT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - INCLUDE_START_ROW_FIELD_NUMBER
```
public static final int INCLUDE_START_ROW_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - INCLUDE_STOP_ROW_FIELD_NUMBER
```
public static final int INCLUDE_STOP_ROW_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - READTYPE_FIELD_NUMBER
```
public static final int READTYPE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - NEED_CURSOR_RESULT_FIELD_NUMBER
```
public static final int NEED_CURSOR_RESULT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PARSER
```
@Deprecated
public static final org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.Scan> PARSER
```
    Deprecated.
- Method Detail
  - getUnknownFields
```
public final org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet getUnknownFields()
```
    Specified by:
    
    getUnknownFields in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
  - getColumnList
```
public List<ClientProtos.Column> getColumnList()
```
    repeated .hbase.pb.Column column = 1;
    
    Specified by:
    
    getColumnList in interface ClientProtos.ScanOrBuilder
  - getColumnOrBuilderList
```
public List<? extends ClientProtos.ColumnOrBuilder> getColumnOrBuilderList()
```
    repeated .hbase.pb.Column column = 1;
    
    Specified by:
    
    getColumnOrBuilderList in interface ClientProtos.ScanOrBuilder
  - getColumnCount
```
public int getColumnCount()
```
    repeated .hbase.pb.Column column = 1;
    
    Specified by:
    
    getColumnCount in interface ClientProtos.ScanOrBuilder
  - getColumn
```
public ClientProtos.Column getColumn(int index)
```
    repeated .hbase.pb.Column column = 1;
    
    Specified by:
    
    getColumn in interface ClientProtos.ScanOrBuilder
  - getColumnOrBuilder
```
public ClientProtos.ColumnOrBuilder getColumnOrBuilder(int index)
```
    repeated .hbase.pb.Column column = 1;
    
    Specified by:
    
    getColumnOrBuilder in interface ClientProtos.ScanOrBuilder
  - getAttributeList
```
public List<HBaseProtos.NameBytesPair> getAttributeList()
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
    
    Specified by:
    
    getAttributeList in interface ClientProtos.ScanOrBuilder
  - getAttributeOrBuilderList
```
public List<? extends HBaseProtos.NameBytesPairOrBuilder> getAttributeOrBuilderList()
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
    
    Specified by:
    
    getAttributeOrBuilderList in interface ClientProtos.ScanOrBuilder
  - getAttributeCount
```
public int getAttributeCount()
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
    
    Specified by:
    
    getAttributeCount in interface ClientProtos.ScanOrBuilder
  - getAttribute
```
public HBaseProtos.NameBytesPair getAttribute(int index)
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
    
    Specified by:
    
    getAttribute in interface ClientProtos.ScanOrBuilder
  - getAttributeOrBuilder
```
public HBaseProtos.NameBytesPairOrBuilder getAttributeOrBuilder(int index)
```
    repeated .hbase.pb.NameBytesPair attribute = 2;
    
    Specified by:
    
    getAttributeOrBuilder in interface ClientProtos.ScanOrBuilder
  - hasStartRow
```
public boolean hasStartRow()
```
    optional bytes start_row = 3;
    
    Specified by:
    
    hasStartRow in interface ClientProtos.ScanOrBuilder
  - getStartRow
```
public org.apache.hbase.thirdparty.com.google.protobuf.ByteString getStartRow()
```
    optional bytes start_row = 3;
    
    Specified by:
    
    getStartRow in interface ClientProtos.ScanOrBuilder
  - hasStopRow
```
public boolean hasStopRow()
```
    optional bytes stop_row = 4;
    
    Specified by:
    
    hasStopRow in interface ClientProtos.ScanOrBuilder
  - getStopRow
```
public org.apache.hbase.thirdparty.com.google.protobuf.ByteString getStopRow()
```
    optional bytes stop_row = 4;
    
    Specified by:
    
    getStopRow in interface ClientProtos.ScanOrBuilder
  - hasFilter
```
public boolean hasFilter()
```
    optional .hbase.pb.Filter filter = 5;
    
    Specified by:
    
    hasFilter in interface ClientProtos.ScanOrBuilder
  - getFilter
```
public FilterProtos.Filter getFilter()
```
    optional .hbase.pb.Filter filter = 5;
    
    Specified by:
    
    getFilter in interface ClientProtos.ScanOrBuilder
  - getFilterOrBuilder
```
public FilterProtos.FilterOrBuilder getFilterOrBuilder()
```
    optional .hbase.pb.Filter filter = 5;
    
    Specified by:
    
    getFilterOrBuilder in interface ClientProtos.ScanOrBuilder
  - hasTimeRange
```
public boolean hasTimeRange()
```
    optional .hbase.pb.TimeRange time_range = 6;
    
    Specified by:
    
    hasTimeRange in interface ClientProtos.ScanOrBuilder
  - getTimeRange
```
public HBaseProtos.TimeRange getTimeRange()
```
    optional .hbase.pb.TimeRange time_range = 6;
    
    Specified by:
    
    getTimeRange in interface ClientProtos.ScanOrBuilder
  - getTimeRangeOrBuilder
```
public HBaseProtos.TimeRangeOrBuilder getTimeRangeOrBuilder()
```
    optional .hbase.pb.TimeRange time_range = 6;
    
    Specified by:
    
    getTimeRangeOrBuilder in interface ClientProtos.ScanOrBuilder
  - hasMaxVersions
```
public boolean hasMaxVersions()
```
    optional uint32 max_versions = 7 [default = 1];
    
    Specified by:
    
    hasMaxVersions in interface ClientProtos.ScanOrBuilder
  - getMaxVersions
```
public int getMaxVersions()
```
    optional uint32 max_versions = 7 [default = 1];
    
    Specified by:
    
    getMaxVersions in interface ClientProtos.ScanOrBuilder
  - hasCacheBlocks
```
public boolean hasCacheBlocks()
```
    optional bool cache_blocks = 8 [default = true];
    
    Specified by:
    
    hasCacheBlocks in interface ClientProtos.ScanOrBuilder
  - getCacheBlocks
```
public boolean getCacheBlocks()
```
    optional bool cache_blocks = 8 [default = true];
    
    Specified by:
    
    getCacheBlocks in interface ClientProtos.ScanOrBuilder
  - hasBatchSize
```
public boolean hasBatchSize()
```
    optional uint32 batch_size = 9;
    
    Specified by:
    
    hasBatchSize in interface ClientProtos.ScanOrBuilder
  - getBatchSize
```
public int getBatchSize()
```
    optional uint32 batch_size = 9;
    
    Specified by:
    
    getBatchSize in interface ClientProtos.ScanOrBuilder
  - hasMaxResultSize
```
public boolean hasMaxResultSize()
```
    optional uint64 max_result_size = 10;
    
    Specified by:
    
    hasMaxResultSize in interface ClientProtos.ScanOrBuilder
  - getMaxResultSize
```
public long getMaxResultSize()
```
    optional uint64 max_result_size = 10;
    
    Specified by:
    
    getMaxResultSize in interface ClientProtos.ScanOrBuilder
  - hasStoreLimit
```
public boolean hasStoreLimit()
```
    optional uint32 store_limit = 11;
    
    Specified by:
    
    hasStoreLimit in interface ClientProtos.ScanOrBuilder
  - getStoreLimit
```
public int getStoreLimit()
```
    optional uint32 store_limit = 11;
    
    Specified by:
    
    getStoreLimit in interface ClientProtos.ScanOrBuilder
  - hasStoreOffset
```
public boolean hasStoreOffset()
```
    optional uint32 store_offset = 12;
    
    Specified by:
    
    hasStoreOffset in interface ClientProtos.ScanOrBuilder
  - getStoreOffset
```
public int getStoreOffset()
```
    optional uint32 store_offset = 12;
    
    Specified by:
    
    getStoreOffset in interface ClientProtos.ScanOrBuilder
  - hasLoadColumnFamiliesOnDemand
```
public boolean hasLoadColumnFamiliesOnDemand()
```
```
 DO NOT add defaults to load_column_families_on_demand. 
 
```
    optional bool load_column_families_on_demand = 13;
    Specified by:
    
    hasLoadColumnFamiliesOnDemand in interface ClientProtos.ScanOrBuilder
  - getLoadColumnFamiliesOnDemand
```
public boolean getLoadColumnFamiliesOnDemand()
```
```
 DO NOT add defaults to load_column_families_on_demand. 
 
```
    optional bool load_column_families_on_demand = 13;
    Specified by:
    
    getLoadColumnFamiliesOnDemand in interface ClientProtos.ScanOrBuilder
  - hasSmall
```
@Deprecated
public boolean hasSmall()
```
    Deprecated.
    
    optional bool small = 14 [deprecated = true];
    
    Specified by:
    
    hasSmall in interface ClientProtos.ScanOrBuilder
  - getSmall
```
@Deprecated
public boolean getSmall()
```
    Deprecated.
    
    optional bool small = 14 [deprecated = true];
    
    Specified by:
    
    getSmall in interface ClientProtos.ScanOrBuilder
  - hasReversed
```
public boolean hasReversed()
```
    optional bool reversed = 15 [default = false];
    
    Specified by:
    
    hasReversed in interface ClientProtos.ScanOrBuilder
  - getReversed
```
public boolean getReversed()
```
    optional bool reversed = 15 [default = false];
    
    Specified by:
    
    getReversed in interface ClientProtos.ScanOrBuilder
  - hasConsistency
```
public boolean hasConsistency()
```
    optional .hbase.pb.Consistency consistency = 16 [default = STRONG];
    
    Specified by:
    
    hasConsistency in interface ClientProtos.ScanOrBuilder
  - getConsistency
```
public ClientProtos.Consistency getConsistency()
```
    optional .hbase.pb.Consistency consistency = 16 [default = STRONG];
    
    Specified by:
    
    getConsistency in interface ClientProtos.ScanOrBuilder
  - hasCaching
```
public boolean hasCaching()
```
    optional uint32 caching = 17;
    
    Specified by:
    
    hasCaching in interface ClientProtos.ScanOrBuilder
  - getCaching
```
public int getCaching()
```
    optional uint32 caching = 17;
    
    Specified by:
    
    getCaching in interface ClientProtos.ScanOrBuilder
  - hasAllowPartialResults
```
public boolean hasAllowPartialResults()
```
    optional bool allow_partial_results = 18;
    
    Specified by:
    
    hasAllowPartialResults in interface ClientProtos.ScanOrBuilder
  - getAllowPartialResults
```
public boolean getAllowPartialResults()
```
    optional bool allow_partial_results = 18;
    
    Specified by:
    
    getAllowPartialResults in interface ClientProtos.ScanOrBuilder
  - getCfTimeRangeList
```
public List<HBaseProtos.ColumnFamilyTimeRange> getCfTimeRangeList()
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
    
    Specified by:
    
    getCfTimeRangeList in interface ClientProtos.ScanOrBuilder
  - getCfTimeRangeOrBuilderList
```
public List<? extends HBaseProtos.ColumnFamilyTimeRangeOrBuilder> getCfTimeRangeOrBuilderList()
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
    
    Specified by:
    
    getCfTimeRangeOrBuilderList in interface ClientProtos.ScanOrBuilder
  - getCfTimeRangeCount
```
public int getCfTimeRangeCount()
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
    
    Specified by:
    
    getCfTimeRangeCount in interface ClientProtos.ScanOrBuilder
  - getCfTimeRange
```
public HBaseProtos.ColumnFamilyTimeRange getCfTimeRange(int index)
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
    
    Specified by:
    
    getCfTimeRange in interface ClientProtos.ScanOrBuilder
  - getCfTimeRangeOrBuilder
```
public HBaseProtos.ColumnFamilyTimeRangeOrBuilder getCfTimeRangeOrBuilder(int index)
```
    repeated .hbase.pb.ColumnFamilyTimeRange cf_time_range = 19;
    
    Specified by:
    
    getCfTimeRangeOrBuilder in interface ClientProtos.ScanOrBuilder
  - hasMvccReadPoint
```
public boolean hasMvccReadPoint()
```
    optional uint64 mvcc_read_point = 20 [default = 0];
    
    Specified by:
    
    hasMvccReadPoint in interface ClientProtos.ScanOrBuilder
  - getMvccReadPoint
```
public long getMvccReadPoint()
```
    optional uint64 mvcc_read_point = 20 [default = 0];
    
    Specified by:
    
    getMvccReadPoint in interface ClientProtos.ScanOrBuilder
  - hasIncludeStartRow
```
public boolean hasIncludeStartRow()
```
    optional bool include_start_row = 21 [default = true];
    
    Specified by:
    
    hasIncludeStartRow in interface ClientProtos.ScanOrBuilder
  - getIncludeStartRow
```
public boolean getIncludeStartRow()
```
    optional bool include_start_row = 21 [default = true];
    
    Specified by:
    
    getIncludeStartRow in interface ClientProtos.ScanOrBuilder
  - hasIncludeStopRow
```
public boolean hasIncludeStopRow()
```
    optional bool include_stop_row = 22 [default = false];
    
    Specified by:
    
    hasIncludeStopRow in interface ClientProtos.ScanOrBuilder
  - getIncludeStopRow
```
public boolean getIncludeStopRow()
```
    optional bool include_stop_row = 22 [default = false];
    
    Specified by:
    
    getIncludeStopRow in interface ClientProtos.ScanOrBuilder
  - hasReadType
```
public boolean hasReadType()
```
    optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];
    
    Specified by:
    
    hasReadType in interface ClientProtos.ScanOrBuilder
  - getReadType
```
public ClientProtos.Scan.ReadType getReadType()
```
    optional .hbase.pb.Scan.ReadType readType = 23 [default = DEFAULT];
    
    Specified by:
    
    getReadType in interface ClientProtos.ScanOrBuilder
  - hasNeedCursorResult
```
public boolean hasNeedCursorResult()
```
    optional bool need_cursor_result = 24 [default = false];
    
    Specified by:
    
    hasNeedCursorResult in interface ClientProtos.ScanOrBuilder
  - getNeedCursorResult
```
public boolean getNeedCursorResult()
```
    optional bool need_cursor_result = 24 [default = false];
    
    Specified by:
    
    getNeedCursorResult in interface ClientProtos.ScanOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(org.apache.hbase.thirdparty.com.google.protobuf.CodedOutputStream output)
             throws IOException
```
    Specified by:
    
    writeTo in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Specified by:
    
    getSerializedSize in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite
    
    Overrides:
    
    getSerializedSize in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface org.apache.hbase.thirdparty.com.google.protobuf.Message
    
    Overrides:
    
    equals in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface org.apache.hbase.thirdparty.com.google.protobuf.Message
    
    Overrides:
    
    hashCode in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage
  - parseFrom
```
public static ClientProtos.Scan parseFrom(ByteBuffer data)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(ByteBuffer data,
                                          org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data,
                                          org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(byte[] data)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(byte[] data,
                                          org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(InputStream input)
                                   throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(InputStream input,
                                          org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static ClientProtos.Scan parseDelimitedFrom(InputStream input)
                                            throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static ClientProtos.Scan parseDelimitedFrom(InputStream input,
                                                   org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input)
                                   throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static ClientProtos.Scan parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input,
                                          org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public ClientProtos.Scan.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface org.apache.hbase.thirdparty.com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite
  - newBuilder
```
public static ClientProtos.Scan.Builder newBuilder()
```
  - newBuilder
```
public static ClientProtos.Scan.Builder newBuilder(ClientProtos.Scan prototype)
```
  - toBuilder
```
public ClientProtos.Scan.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface org.apache.hbase.thirdparty.com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite
  - newBuilderForType
```
protected ClientProtos.Scan.Builder newBuilderForType(org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static ClientProtos.Scan getDefaultInstance()
```
  - parser
```
public static org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.Scan> parser()
```
  - getParserForType
```
public org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.Scan> getParserForType()
```
    Specified by:
    
    getParserForType in interface org.apache.hbase.thirdparty.com.google.protobuf.Message
    
    Specified by:
    
    getParserForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite
    
    Overrides:
    
    getParserForType in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public ClientProtos.Scan getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

Class ClientProtos.Scan

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3

Field Summary

Fields inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3

Fields inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage

Fields inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

Methods inherited from interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite

Field Detail

COLUMN_FIELD_NUMBER

ATTRIBUTE_FIELD_NUMBER

START_ROW_FIELD_NUMBER

STOP_ROW_FIELD_NUMBER

FILTER_FIELD_NUMBER

TIME_RANGE_FIELD_NUMBER

MAX_VERSIONS_FIELD_NUMBER

CACHE_BLOCKS_FIELD_NUMBER

BATCH_SIZE_FIELD_NUMBER

MAX_RESULT_SIZE_FIELD_NUMBER

STORE_LIMIT_FIELD_NUMBER

STORE_OFFSET_FIELD_NUMBER

LOAD_COLUMN_FAMILIES_ON_DEMAND_FIELD_NUMBER

SMALL_FIELD_NUMBER

REVERSED_FIELD_NUMBER

CONSISTENCY_FIELD_NUMBER

CACHING_FIELD_NUMBER

ALLOW_PARTIAL_RESULTS_FIELD_NUMBER

CF_TIME_RANGE_FIELD_NUMBER

MVCC_READ_POINT_FIELD_NUMBER

INCLUDE_START_ROW_FIELD_NUMBER

INCLUDE_STOP_ROW_FIELD_NUMBER

READTYPE_FIELD_NUMBER

NEED_CURSOR_RESULT_FIELD_NUMBER

PARSER

Method Detail

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getColumnList

getColumnOrBuilderList

getColumnCount

getColumn

getColumnOrBuilder

getAttributeList

getAttributeOrBuilderList

getAttributeCount

getAttribute

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