public static final class ClientPB.Scan.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder> implements ClientPB.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
Scan
Modifier and Type | Method and Description |
---|---|
ClientPB.Scan.Builder |
addAllAttribute(Iterable<? extends HBasePB.NameBytesPair> values)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
addAllColumn(Iterable<? extends ClientPB.Column> values)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
addAttribute(HBasePB.NameBytesPair.Builder builderForValue)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
addAttribute(HBasePB.NameBytesPair value)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
addAttribute(int index,
HBasePB.NameBytesPair.Builder builderForValue)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
addAttribute(int index,
HBasePB.NameBytesPair value)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
addColumn(ClientPB.Column.Builder builderForValue)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
addColumn(ClientPB.Column value)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
addColumn(int index,
ClientPB.Column.Builder builderForValue)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
addColumn(int index,
ClientPB.Column value)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
clearAttribute()
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
clearBatchSize()
optional uint32 batch_size = 9; |
ClientPB.Scan.Builder |
clearCacheBlocks()
optional bool cache_blocks = 8 [default = true]; |
ClientPB.Scan.Builder |
clearCaching()
optional uint32 caching = 17; |
ClientPB.Scan.Builder |
clearColumn()
repeated .Column column = 1; |
ClientPB.Scan.Builder |
clearFilter()
optional .Filter filter = 5; |
ClientPB.Scan.Builder |
clearLoadColumnFamiliesOnDemand()
DO NOT add defaults to load_column_families_on_demand.
|
ClientPB.Scan.Builder |
clearMaxResultSize()
optional uint64 max_result_size = 10; |
ClientPB.Scan.Builder |
clearMaxVersions()
optional uint32 max_versions = 7 [default = 1]; |
ClientPB.Scan.Builder |
clearReversed()
optional bool reversed = 15 [default = false]; |
ClientPB.Scan.Builder |
clearSmall()
optional bool small = 14; |
ClientPB.Scan.Builder |
clearStartRow()
optional bytes start_row = 3; |
ClientPB.Scan.Builder |
clearStopRow()
optional bytes stop_row = 4; |
ClientPB.Scan.Builder |
clearStoreLimit()
optional uint32 store_limit = 11; |
ClientPB.Scan.Builder |
clearStoreOffset()
optional uint32 store_offset = 12; |
ClientPB.Scan.Builder |
clearTimeRange()
optional .TimeRange time_range = 6; |
HBasePB.NameBytesPair |
getAttribute(int index)
repeated .NameBytesPair attribute = 2; |
int |
getAttributeCount()
repeated .NameBytesPair attribute = 2; |
List<HBasePB.NameBytesPair> |
getAttributeList()
repeated .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; |
ClientPB.Column |
getColumn(int index)
repeated .Column column = 1; |
int |
getColumnCount()
repeated .Column column = 1; |
List<ClientPB.Column> |
getColumnList()
repeated .Column column = 1; |
FilterPB.Filter |
getFilter()
optional .Filter filter = 5; |
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]; |
boolean |
getReversed()
optional bool reversed = 15 [default = false]; |
boolean |
getSmall()
optional bool small = 14; |
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; |
HBasePB.TimeRange |
getTimeRange()
optional .TimeRange time_range = 6; |
boolean |
hasBatchSize()
optional uint32 batch_size = 9; |
boolean |
hasCacheBlocks()
optional bool cache_blocks = 8 [default = true]; |
boolean |
hasCaching()
optional uint32 caching = 17; |
boolean |
hasFilter()
optional .Filter filter = 5; |
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 |
hasReversed()
optional bool reversed = 15 [default = false]; |
boolean |
hasSmall()
optional bool small = 14; |
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 .TimeRange time_range = 6; |
ClientPB.Scan.Builder |
mergeFilter(FilterPB.Filter value)
optional .Filter filter = 5; |
ClientPB.Scan.Builder |
mergeTimeRange(HBasePB.TimeRange value)
optional .TimeRange time_range = 6; |
ClientPB.Scan.Builder |
removeAttribute(int index)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
removeColumn(int index)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
setAttribute(int index,
HBasePB.NameBytesPair.Builder builderForValue)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
setAttribute(int index,
HBasePB.NameBytesPair value)
repeated .NameBytesPair attribute = 2; |
ClientPB.Scan.Builder |
setBatchSize(int value)
optional uint32 batch_size = 9; |
ClientPB.Scan.Builder |
setCacheBlocks(boolean value)
optional bool cache_blocks = 8 [default = true]; |
ClientPB.Scan.Builder |
setCaching(int value)
optional uint32 caching = 17; |
ClientPB.Scan.Builder |
setColumn(int index,
ClientPB.Column.Builder builderForValue)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
setColumn(int index,
ClientPB.Column value)
repeated .Column column = 1; |
ClientPB.Scan.Builder |
setFilter(FilterPB.Filter.Builder builderForValue)
optional .Filter filter = 5; |
ClientPB.Scan.Builder |
setFilter(FilterPB.Filter value)
optional .Filter filter = 5; |
ClientPB.Scan.Builder |
setLoadColumnFamiliesOnDemand(boolean value)
DO NOT add defaults to load_column_families_on_demand.
|
ClientPB.Scan.Builder |
setMaxResultSize(long value)
optional uint64 max_result_size = 10; |
ClientPB.Scan.Builder |
setMaxVersions(int value)
optional uint32 max_versions = 7 [default = 1]; |
ClientPB.Scan.Builder |
setReversed(boolean value)
optional bool reversed = 15 [default = false]; |
ClientPB.Scan.Builder |
setSmall(boolean value)
optional bool small = 14; |
ClientPB.Scan.Builder |
setStartRow(com.google.protobuf.ByteString value)
optional bytes start_row = 3; |
ClientPB.Scan.Builder |
setStopRow(com.google.protobuf.ByteString value)
optional bytes stop_row = 4; |
ClientPB.Scan.Builder |
setStoreLimit(int value)
optional uint32 store_limit = 11; |
ClientPB.Scan.Builder |
setStoreOffset(int value)
optional uint32 store_offset = 12; |
ClientPB.Scan.Builder |
setTimeRange(HBasePB.TimeRange.Builder builderForValue)
optional .TimeRange time_range = 6; |
ClientPB.Scan.Builder |
setTimeRange(HBasePB.TimeRange value)
optional .TimeRange time_range = 6; |
build, buildPartial, clear, clone, copyOnWrite, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
public List<ClientPB.Column> getColumnList()
repeated .Column column = 1;
getColumnList
in interface ClientPB.ScanOrBuilder
public int getColumnCount()
repeated .Column column = 1;
getColumnCount
in interface ClientPB.ScanOrBuilder
public ClientPB.Column getColumn(int index)
repeated .Column column = 1;
getColumn
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setColumn(int index, ClientPB.Column value)
repeated .Column column = 1;
public ClientPB.Scan.Builder setColumn(int index, ClientPB.Column.Builder builderForValue)
repeated .Column column = 1;
public ClientPB.Scan.Builder addColumn(ClientPB.Column value)
repeated .Column column = 1;
public ClientPB.Scan.Builder addColumn(int index, ClientPB.Column value)
repeated .Column column = 1;
public ClientPB.Scan.Builder addColumn(ClientPB.Column.Builder builderForValue)
repeated .Column column = 1;
public ClientPB.Scan.Builder addColumn(int index, ClientPB.Column.Builder builderForValue)
repeated .Column column = 1;
public ClientPB.Scan.Builder addAllColumn(Iterable<? extends ClientPB.Column> values)
repeated .Column column = 1;
public ClientPB.Scan.Builder clearColumn()
repeated .Column column = 1;
public ClientPB.Scan.Builder removeColumn(int index)
repeated .Column column = 1;
public List<HBasePB.NameBytesPair> getAttributeList()
repeated .NameBytesPair attribute = 2;
getAttributeList
in interface ClientPB.ScanOrBuilder
public int getAttributeCount()
repeated .NameBytesPair attribute = 2;
getAttributeCount
in interface ClientPB.ScanOrBuilder
public HBasePB.NameBytesPair getAttribute(int index)
repeated .NameBytesPair attribute = 2;
getAttribute
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setAttribute(int index, HBasePB.NameBytesPair value)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder setAttribute(int index, HBasePB.NameBytesPair.Builder builderForValue)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder addAttribute(HBasePB.NameBytesPair value)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder addAttribute(int index, HBasePB.NameBytesPair value)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder addAttribute(HBasePB.NameBytesPair.Builder builderForValue)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder addAttribute(int index, HBasePB.NameBytesPair.Builder builderForValue)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder addAllAttribute(Iterable<? extends HBasePB.NameBytesPair> values)
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder clearAttribute()
repeated .NameBytesPair attribute = 2;
public ClientPB.Scan.Builder removeAttribute(int index)
repeated .NameBytesPair attribute = 2;
public boolean hasStartRow()
optional bytes start_row = 3;
hasStartRow
in interface ClientPB.ScanOrBuilder
public com.google.protobuf.ByteString getStartRow()
optional bytes start_row = 3;
getStartRow
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setStartRow(com.google.protobuf.ByteString value)
optional bytes start_row = 3;
public ClientPB.Scan.Builder clearStartRow()
optional bytes start_row = 3;
public boolean hasStopRow()
optional bytes stop_row = 4;
hasStopRow
in interface ClientPB.ScanOrBuilder
public com.google.protobuf.ByteString getStopRow()
optional bytes stop_row = 4;
getStopRow
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setStopRow(com.google.protobuf.ByteString value)
optional bytes stop_row = 4;
public ClientPB.Scan.Builder clearStopRow()
optional bytes stop_row = 4;
public boolean hasFilter()
optional .Filter filter = 5;
hasFilter
in interface ClientPB.ScanOrBuilder
public FilterPB.Filter getFilter()
optional .Filter filter = 5;
getFilter
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setFilter(FilterPB.Filter value)
optional .Filter filter = 5;
public ClientPB.Scan.Builder setFilter(FilterPB.Filter.Builder builderForValue)
optional .Filter filter = 5;
public ClientPB.Scan.Builder mergeFilter(FilterPB.Filter value)
optional .Filter filter = 5;
public ClientPB.Scan.Builder clearFilter()
optional .Filter filter = 5;
public boolean hasTimeRange()
optional .TimeRange time_range = 6;
hasTimeRange
in interface ClientPB.ScanOrBuilder
public HBasePB.TimeRange getTimeRange()
optional .TimeRange time_range = 6;
getTimeRange
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setTimeRange(HBasePB.TimeRange value)
optional .TimeRange time_range = 6;
public ClientPB.Scan.Builder setTimeRange(HBasePB.TimeRange.Builder builderForValue)
optional .TimeRange time_range = 6;
public ClientPB.Scan.Builder mergeTimeRange(HBasePB.TimeRange value)
optional .TimeRange time_range = 6;
public ClientPB.Scan.Builder clearTimeRange()
optional .TimeRange time_range = 6;
public boolean hasMaxVersions()
optional uint32 max_versions = 7 [default = 1];
hasMaxVersions
in interface ClientPB.ScanOrBuilder
public int getMaxVersions()
optional uint32 max_versions = 7 [default = 1];
getMaxVersions
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setMaxVersions(int value)
optional uint32 max_versions = 7 [default = 1];
public ClientPB.Scan.Builder clearMaxVersions()
optional uint32 max_versions = 7 [default = 1];
public boolean hasCacheBlocks()
optional bool cache_blocks = 8 [default = true];
hasCacheBlocks
in interface ClientPB.ScanOrBuilder
public boolean getCacheBlocks()
optional bool cache_blocks = 8 [default = true];
getCacheBlocks
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setCacheBlocks(boolean value)
optional bool cache_blocks = 8 [default = true];
public ClientPB.Scan.Builder clearCacheBlocks()
optional bool cache_blocks = 8 [default = true];
public boolean hasBatchSize()
optional uint32 batch_size = 9;
hasBatchSize
in interface ClientPB.ScanOrBuilder
public int getBatchSize()
optional uint32 batch_size = 9;
getBatchSize
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setBatchSize(int value)
optional uint32 batch_size = 9;
public ClientPB.Scan.Builder clearBatchSize()
optional uint32 batch_size = 9;
public boolean hasMaxResultSize()
optional uint64 max_result_size = 10;
hasMaxResultSize
in interface ClientPB.ScanOrBuilder
public long getMaxResultSize()
optional uint64 max_result_size = 10;
getMaxResultSize
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setMaxResultSize(long value)
optional uint64 max_result_size = 10;
public ClientPB.Scan.Builder clearMaxResultSize()
optional uint64 max_result_size = 10;
public boolean hasStoreLimit()
optional uint32 store_limit = 11;
hasStoreLimit
in interface ClientPB.ScanOrBuilder
public int getStoreLimit()
optional uint32 store_limit = 11;
getStoreLimit
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setStoreLimit(int value)
optional uint32 store_limit = 11;
public ClientPB.Scan.Builder clearStoreLimit()
optional uint32 store_limit = 11;
public boolean hasStoreOffset()
optional uint32 store_offset = 12;
hasStoreOffset
in interface ClientPB.ScanOrBuilder
public int getStoreOffset()
optional uint32 store_offset = 12;
getStoreOffset
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setStoreOffset(int value)
optional uint32 store_offset = 12;
public ClientPB.Scan.Builder clearStoreOffset()
optional uint32 store_offset = 12;
public boolean hasLoadColumnFamiliesOnDemand()
DO NOT add defaults to load_column_families_on_demand.
optional bool load_column_families_on_demand = 13;
hasLoadColumnFamiliesOnDemand
in interface ClientPB.ScanOrBuilder
public boolean getLoadColumnFamiliesOnDemand()
DO NOT add defaults to load_column_families_on_demand.
optional bool load_column_families_on_demand = 13;
getLoadColumnFamiliesOnDemand
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setLoadColumnFamiliesOnDemand(boolean value)
DO NOT add defaults to load_column_families_on_demand.
optional bool load_column_families_on_demand = 13;
public ClientPB.Scan.Builder clearLoadColumnFamiliesOnDemand()
DO NOT add defaults to load_column_families_on_demand.
optional bool load_column_families_on_demand = 13;
public boolean hasSmall()
optional bool small = 14;
hasSmall
in interface ClientPB.ScanOrBuilder
public boolean getSmall()
optional bool small = 14;
getSmall
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setSmall(boolean value)
optional bool small = 14;
public ClientPB.Scan.Builder clearSmall()
optional bool small = 14;
public boolean hasReversed()
optional bool reversed = 15 [default = false];
hasReversed
in interface ClientPB.ScanOrBuilder
public boolean getReversed()
optional bool reversed = 15 [default = false];
getReversed
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setReversed(boolean value)
optional bool reversed = 15 [default = false];
public ClientPB.Scan.Builder clearReversed()
optional bool reversed = 15 [default = false];
public boolean hasCaching()
optional uint32 caching = 17;
hasCaching
in interface ClientPB.ScanOrBuilder
public int getCaching()
optional uint32 caching = 17;
getCaching
in interface ClientPB.ScanOrBuilder
public ClientPB.Scan.Builder setCaching(int value)
optional uint32 caching = 17;
public ClientPB.Scan.Builder clearCaching()
optional uint32 caching = 17;
Copyright © 2010–2018 The Async HBase Authors. All rights reserved.