public static final class ClientPB.Scan extends com.google.protobuf.GeneratedMessageLite<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 | Class and Description |
---|---|
static class |
ClientPB.Scan.Builder
Instead of get from a table, you can scan it with optional filters.
|
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MergeFromVisitor, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm, com.google.protobuf.GeneratedMessageLite.Visitor
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 |
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 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 |
---|---|
protected Object |
dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method,
Object arg0,
Object arg1) |
HBasePB.NameBytesPair |
getAttribute(int index)
repeated .NameBytesPair attribute = 2; |
int |
getAttributeCount()
repeated .NameBytesPair attribute = 2; |
List<HBasePB.NameBytesPair> |
getAttributeList()
repeated .NameBytesPair attribute = 2; |
HBasePB.NameBytesPairOrBuilder |
getAttributeOrBuilder(int index)
repeated .NameBytesPair attribute = 2; |
List<? extends HBasePB.NameBytesPairOrBuilder> |
getAttributeOrBuilderList()
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; |
ClientPB.ColumnOrBuilder |
getColumnOrBuilder(int index)
repeated .Column column = 1; |
List<? extends ClientPB.ColumnOrBuilder> |
getColumnOrBuilderList()
repeated .Column column = 1; |
static ClientPB.Scan |
getDefaultInstance() |
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]; |
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; |
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; |
static ClientPB.Scan.Builder |
newBuilder() |
static ClientPB.Scan.Builder |
newBuilder(ClientPB.Scan prototype) |
static ClientPB.Scan |
parseDelimitedFrom(InputStream input) |
static ClientPB.Scan |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.Scan |
parseFrom(byte[] data) |
static ClientPB.Scan |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.Scan |
parseFrom(ByteBuffer data) |
static ClientPB.Scan |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.Scan |
parseFrom(com.google.protobuf.ByteString data) |
static ClientPB.Scan |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.Scan |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClientPB.Scan |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.Scan |
parseFrom(InputStream input) |
static ClientPB.Scan |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ClientPB.Scan> |
parser() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, hashCode, isInitialized, isInitialized, makeImmutable, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, toBuilder, toString
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
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 CACHING_FIELD_NUMBER
public List<ClientPB.Column> getColumnList()
repeated .Column column = 1;
getColumnList
in interface ClientPB.ScanOrBuilder
public List<? extends ClientPB.ColumnOrBuilder> getColumnOrBuilderList()
repeated .Column column = 1;
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.ColumnOrBuilder getColumnOrBuilder(int index)
repeated .Column column = 1;
public List<HBasePB.NameBytesPair> getAttributeList()
repeated .NameBytesPair attribute = 2;
getAttributeList
in interface ClientPB.ScanOrBuilder
public List<? extends HBasePB.NameBytesPairOrBuilder> getAttributeOrBuilderList()
repeated .NameBytesPair attribute = 2;
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 HBasePB.NameBytesPairOrBuilder getAttributeOrBuilder(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 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 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 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 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 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 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 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 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 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 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 boolean hasSmall()
optional bool small = 14;
hasSmall
in interface ClientPB.ScanOrBuilder
public boolean getSmall()
optional bool small = 14;
getSmall
in interface ClientPB.ScanOrBuilder
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 boolean hasCaching()
optional uint32 caching = 17;
hasCaching
in interface ClientPB.ScanOrBuilder
public int getCaching()
optional uint32 caching = 17;
getCaching
in interface ClientPB.ScanOrBuilder
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
public static ClientPB.Scan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.Scan parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.Scan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.Scan parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.Scan parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.Scan parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.Scan parseFrom(InputStream input) throws IOException
IOException
public static ClientPB.Scan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ClientPB.Scan parseDelimitedFrom(InputStream input) throws IOException
IOException
public static ClientPB.Scan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ClientPB.Scan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static ClientPB.Scan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ClientPB.Scan.Builder newBuilder()
public static ClientPB.Scan.Builder newBuilder(ClientPB.Scan prototype)
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
dynamicMethod
in class com.google.protobuf.GeneratedMessageLite<ClientPB.Scan,ClientPB.Scan.Builder>
public static ClientPB.Scan getDefaultInstance()
public static com.google.protobuf.Parser<ClientPB.Scan> parser()
Copyright © 2010–2017 The Async HBase Authors. All rights reserved.