public static final class ClientProtos.Scan extends com.google.protobuf.GeneratedMessage implements ClientProtos.ScanOrBuilder
hbase.pb.Scan
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.
Modifier and Type | Class and Description |
---|---|
static class |
ClientProtos.Scan.Builder
Protobuf type
hbase.pb.Scan |
Modifier and Type | Field and Description |
---|---|
static int |
ATTRIBUTE_FIELD_NUMBER |
static int |
BATCH_SIZE_FIELD_NUMBER |
static int |
CACHE_BLOCKS_FIELD_NUMBER |
static int |
CACHING_FIELD_NUMBER |
static int |
COLUMN_FIELD_NUMBER |
static int |
CONSISTENCY_FIELD_NUMBER |
static int |
FILTER_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 <any> |
PARSER |
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 |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
HBaseProtos.NameBytesPair |
getAttribute(int index)
repeated .hbase.pb.NameBytesPair attribute = 2; |
int |
getAttributeCount()
repeated .hbase.pb.NameBytesPair attribute = 2; |
java.util.List<HBaseProtos.NameBytesPair> |
getAttributeList()
repeated .hbase.pb.NameBytesPair attribute = 2; |
HBaseProtos.NameBytesPairOrBuilder |
getAttributeOrBuilder(int index)
repeated .hbase.pb.NameBytesPair attribute = 2; |
java.util.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; |
ClientProtos.Column |
getColumn(int index)
repeated .hbase.pb.Column column = 1; |
int |
getColumnCount()
repeated .hbase.pb.Column column = 1; |
java.util.List<ClientProtos.Column> |
getColumnList()
repeated .hbase.pb.Column column = 1; |
ClientProtos.ColumnOrBuilder |
getColumnOrBuilder(int index)
repeated .hbase.pb.Column column = 1; |
java.util.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 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 |
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]; |
<any> |
getParserForType() |
boolean |
getReversed()
optional bool reversed = 15 [default = false]; |
int |
getSerializedSize() |
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; |
HBaseProtos.TimeRange |
getTimeRange()
optional .hbase.pb.TimeRange time_range = 6; |
HBaseProtos.TimeRangeOrBuilder |
getTimeRangeOrBuilder()
optional .hbase.pb.TimeRange time_range = 6; |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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 |
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 |
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 .hbase.pb.TimeRange time_range = 6; |
protected com.google.protobuf.GeneratedMessage.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(com.google.protobuf.GeneratedMessage.BuilderParent parent) |
static ClientProtos.Scan |
parseDelimitedFrom(java.io.InputStream input) |
static ClientProtos.Scan |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.Scan |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.Scan |
parseFrom(com.google.protobuf.ByteString data) |
static ClientProtos.Scan |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.Scan |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClientProtos.Scan |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.Scan |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ClientProtos.Scan.Builder |
toBuilder() |
protected java.lang.Object |
writeReplace() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
public static <any> PARSER
public static final int COLUMN_FIELD_NUMBER
public static final int ATTRIBUTE_FIELD_NUMBER
public static final int START_ROW_FIELD_NUMBER
public static final int STOP_ROW_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int TIME_RANGE_FIELD_NUMBER
public static final int MAX_VERSIONS_FIELD_NUMBER
public static final int CACHE_BLOCKS_FIELD_NUMBER
public static final int BATCH_SIZE_FIELD_NUMBER
public static final int MAX_RESULT_SIZE_FIELD_NUMBER
public static final int STORE_LIMIT_FIELD_NUMBER
public static final int STORE_OFFSET_FIELD_NUMBER
public static final int LOAD_COLUMN_FAMILIES_ON_DEMAND_FIELD_NUMBER
public static final int SMALL_FIELD_NUMBER
public static final int REVERSED_FIELD_NUMBER
public static final int CONSISTENCY_FIELD_NUMBER
public static final int CACHING_FIELD_NUMBER
public static ClientProtos.Scan getDefaultInstance()
public ClientProtos.Scan getDefaultInstanceForType()
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
public <any> getParserForType()
public java.util.List<ClientProtos.Column> getColumnList()
repeated .hbase.pb.Column column = 1;
getColumnList
in interface ClientProtos.ScanOrBuilder
public java.util.List<? extends ClientProtos.ColumnOrBuilder> getColumnOrBuilderList()
repeated .hbase.pb.Column column = 1;
getColumnOrBuilderList
in interface ClientProtos.ScanOrBuilder
public int getColumnCount()
repeated .hbase.pb.Column column = 1;
getColumnCount
in interface ClientProtos.ScanOrBuilder
public ClientProtos.Column getColumn(int index)
repeated .hbase.pb.Column column = 1;
getColumn
in interface ClientProtos.ScanOrBuilder
public ClientProtos.ColumnOrBuilder getColumnOrBuilder(int index)
repeated .hbase.pb.Column column = 1;
getColumnOrBuilder
in interface ClientProtos.ScanOrBuilder
public java.util.List<HBaseProtos.NameBytesPair> getAttributeList()
repeated .hbase.pb.NameBytesPair attribute = 2;
getAttributeList
in interface ClientProtos.ScanOrBuilder
public java.util.List<? extends HBaseProtos.NameBytesPairOrBuilder> getAttributeOrBuilderList()
repeated .hbase.pb.NameBytesPair attribute = 2;
getAttributeOrBuilderList
in interface ClientProtos.ScanOrBuilder
public int getAttributeCount()
repeated .hbase.pb.NameBytesPair attribute = 2;
getAttributeCount
in interface ClientProtos.ScanOrBuilder
public HBaseProtos.NameBytesPair getAttribute(int index)
repeated .hbase.pb.NameBytesPair attribute = 2;
getAttribute
in interface ClientProtos.ScanOrBuilder
public HBaseProtos.NameBytesPairOrBuilder getAttributeOrBuilder(int index)
repeated .hbase.pb.NameBytesPair attribute = 2;
getAttributeOrBuilder
in interface ClientProtos.ScanOrBuilder
public boolean hasStartRow()
optional bytes start_row = 3;
hasStartRow
in interface ClientProtos.ScanOrBuilder
public com.google.protobuf.ByteString getStartRow()
optional bytes start_row = 3;
getStartRow
in interface ClientProtos.ScanOrBuilder
public boolean hasStopRow()
optional bytes stop_row = 4;
hasStopRow
in interface ClientProtos.ScanOrBuilder
public com.google.protobuf.ByteString getStopRow()
optional bytes stop_row = 4;
getStopRow
in interface ClientProtos.ScanOrBuilder
public boolean hasFilter()
optional .hbase.pb.Filter filter = 5;
hasFilter
in interface ClientProtos.ScanOrBuilder
public FilterProtos.Filter getFilter()
optional .hbase.pb.Filter filter = 5;
getFilter
in interface ClientProtos.ScanOrBuilder
public FilterProtos.FilterOrBuilder getFilterOrBuilder()
optional .hbase.pb.Filter filter = 5;
getFilterOrBuilder
in interface ClientProtos.ScanOrBuilder
public boolean hasTimeRange()
optional .hbase.pb.TimeRange time_range = 6;
hasTimeRange
in interface ClientProtos.ScanOrBuilder
public HBaseProtos.TimeRange getTimeRange()
optional .hbase.pb.TimeRange time_range = 6;
getTimeRange
in interface ClientProtos.ScanOrBuilder
public HBaseProtos.TimeRangeOrBuilder getTimeRangeOrBuilder()
optional .hbase.pb.TimeRange time_range = 6;
getTimeRangeOrBuilder
in interface ClientProtos.ScanOrBuilder
public boolean hasMaxVersions()
optional uint32 max_versions = 7 [default = 1];
hasMaxVersions
in interface ClientProtos.ScanOrBuilder
public int getMaxVersions()
optional uint32 max_versions = 7 [default = 1];
getMaxVersions
in interface ClientProtos.ScanOrBuilder
public boolean hasCacheBlocks()
optional bool cache_blocks = 8 [default = true];
hasCacheBlocks
in interface ClientProtos.ScanOrBuilder
public boolean getCacheBlocks()
optional bool cache_blocks = 8 [default = true];
getCacheBlocks
in interface ClientProtos.ScanOrBuilder
public boolean hasBatchSize()
optional uint32 batch_size = 9;
hasBatchSize
in interface ClientProtos.ScanOrBuilder
public int getBatchSize()
optional uint32 batch_size = 9;
getBatchSize
in interface ClientProtos.ScanOrBuilder
public boolean hasMaxResultSize()
optional uint64 max_result_size = 10;
hasMaxResultSize
in interface ClientProtos.ScanOrBuilder
public long getMaxResultSize()
optional uint64 max_result_size = 10;
getMaxResultSize
in interface ClientProtos.ScanOrBuilder
public boolean hasStoreLimit()
optional uint32 store_limit = 11;
hasStoreLimit
in interface ClientProtos.ScanOrBuilder
public int getStoreLimit()
optional uint32 store_limit = 11;
getStoreLimit
in interface ClientProtos.ScanOrBuilder
public boolean hasStoreOffset()
optional uint32 store_offset = 12;
hasStoreOffset
in interface ClientProtos.ScanOrBuilder
public int getStoreOffset()
optional uint32 store_offset = 12;
getStoreOffset
in interface ClientProtos.ScanOrBuilder
public boolean hasLoadColumnFamiliesOnDemand()
optional bool load_column_families_on_demand = 13;
DO NOT add defaults to load_column_families_on_demand.
hasLoadColumnFamiliesOnDemand
in interface ClientProtos.ScanOrBuilder
public boolean getLoadColumnFamiliesOnDemand()
optional bool load_column_families_on_demand = 13;
DO NOT add defaults to load_column_families_on_demand.
getLoadColumnFamiliesOnDemand
in interface ClientProtos.ScanOrBuilder
public boolean hasSmall()
optional bool small = 14;
hasSmall
in interface ClientProtos.ScanOrBuilder
public boolean getSmall()
optional bool small = 14;
getSmall
in interface ClientProtos.ScanOrBuilder
public boolean hasReversed()
optional bool reversed = 15 [default = false];
hasReversed
in interface ClientProtos.ScanOrBuilder
public boolean getReversed()
optional bool reversed = 15 [default = false];
getReversed
in interface ClientProtos.ScanOrBuilder
public boolean hasConsistency()
optional .hbase.pb.Consistency consistency = 16 [default = STRONG];
hasConsistency
in interface ClientProtos.ScanOrBuilder
public ClientProtos.Consistency getConsistency()
optional .hbase.pb.Consistency consistency = 16 [default = STRONG];
getConsistency
in interface ClientProtos.ScanOrBuilder
public boolean hasCaching()
optional uint32 caching = 17;
hasCaching
in interface ClientProtos.ScanOrBuilder
public int getCaching()
optional uint32 caching = 17;
getCaching
in interface ClientProtos.ScanOrBuilder
public final boolean isInitialized()
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
java.io.IOException
public int getSerializedSize()
protected java.lang.Object writeReplace() throws java.io.ObjectStreamException
java.io.ObjectStreamException
public boolean equals(java.lang.Object obj)
public int hashCode()
public static ClientProtos.Scan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientProtos.Scan parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientProtos.Scan parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientProtos.Scan parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static ClientProtos.Scan parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static ClientProtos.Scan parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static ClientProtos.Scan parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static ClientProtos.Scan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static ClientProtos.Scan.Builder newBuilder()
public ClientProtos.Scan.Builder newBuilderForType()
public static ClientProtos.Scan.Builder newBuilder(ClientProtos.Scan prototype)
public ClientProtos.Scan.Builder toBuilder()
protected ClientProtos.Scan.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)