org.hbase.async.generated
Class ClientPB.Scan

java.lang.Object
  extended by com.google.protobuf.AbstractMessageLite
      extended by com.google.protobuf.GeneratedMessageLite
          extended by org.hbase.async.generated.ClientPB.Scan
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Serializable, ClientPB.ScanOrBuilder
Enclosing class:
ClientPB

public static final class ClientPB.Scan
extends com.google.protobuf.GeneratedMessageLite
implements ClientPB.ScanOrBuilder

Protobuf type 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.
 

See Also:
Serialized Form

Nested Class Summary
static class ClientPB.Scan.Builder
          Protobuf type Scan
 
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>
 
Field Summary
static int ATTRIBUTE_FIELD_NUMBER
           
static int BATCH_SIZE_FIELD_NUMBER
           
static int CACHE_BLOCKS_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 com.google.protobuf.Parser<ClientPB.Scan> PARSER
           
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
           
 
Method Summary
 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];
 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()
           
 ClientPB.Scan getDefaultInstanceForType()
           
 FilterPB.Filter getFilter()
          optional .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];
 com.google.protobuf.Parser<ClientPB.Scan> getParserForType()
           
 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 hasFilter()
          optional .Filter filter = 5;
 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 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;
 boolean isInitialized()
           
static ClientPB.Scan.Builder newBuilder()
           
static ClientPB.Scan.Builder newBuilder(ClientPB.Scan prototype)
           
 ClientPB.Scan.Builder newBuilderForType()
           
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(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)
           
 ClientPB.Scan.Builder toBuilder()
           
protected  Object writeReplace()
           
 void writeTo(com.google.protobuf.CodedOutputStream output)
           
 
Methods inherited from class com.google.protobuf.GeneratedMessageLite
makeExtensionsImmutable, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseUnknownField
 
Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARSER

public static com.google.protobuf.Parser<ClientPB.Scan> PARSER

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
Method Detail

getDefaultInstance

public static ClientPB.Scan getDefaultInstance()

getDefaultInstanceForType

public ClientPB.Scan getDefaultInstanceForType()
Specified by:
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

getParserForType

public com.google.protobuf.Parser<ClientPB.Scan> getParserForType()
Specified by:
getParserForType in interface com.google.protobuf.MessageLite
Overrides:
getParserForType in class com.google.protobuf.GeneratedMessageLite

getColumnList

public List<ClientPB.Column> getColumnList()
repeated .Column column = 1;

Specified by:
getColumnList in interface ClientPB.ScanOrBuilder

getColumnOrBuilderList

public List<? extends ClientPB.ColumnOrBuilder> getColumnOrBuilderList()
repeated .Column column = 1;


getColumnCount

public int getColumnCount()
repeated .Column column = 1;

Specified by:
getColumnCount in interface ClientPB.ScanOrBuilder

getColumn

public ClientPB.Column getColumn(int index)
repeated .Column column = 1;

Specified by:
getColumn in interface ClientPB.ScanOrBuilder

getColumnOrBuilder

public ClientPB.ColumnOrBuilder getColumnOrBuilder(int index)
repeated .Column column = 1;


getAttributeList

public List<HBasePB.NameBytesPair> getAttributeList()
repeated .NameBytesPair attribute = 2;

Specified by:
getAttributeList in interface ClientPB.ScanOrBuilder

getAttributeOrBuilderList

public List<? extends HBasePB.NameBytesPairOrBuilder> getAttributeOrBuilderList()
repeated .NameBytesPair attribute = 2;


getAttributeCount

public int getAttributeCount()
repeated .NameBytesPair attribute = 2;

Specified by:
getAttributeCount in interface ClientPB.ScanOrBuilder

getAttribute

public HBasePB.NameBytesPair getAttribute(int index)
repeated .NameBytesPair attribute = 2;

Specified by:
getAttribute in interface ClientPB.ScanOrBuilder

getAttributeOrBuilder

public HBasePB.NameBytesPairOrBuilder getAttributeOrBuilder(int index)
repeated .NameBytesPair attribute = 2;


hasStartRow

public boolean hasStartRow()
optional bytes start_row = 3;

Specified by:
hasStartRow in interface ClientPB.ScanOrBuilder

getStartRow

public com.google.protobuf.ByteString getStartRow()
optional bytes start_row = 3;

Specified by:
getStartRow in interface ClientPB.ScanOrBuilder

hasStopRow

public boolean hasStopRow()
optional bytes stop_row = 4;

Specified by:
hasStopRow in interface ClientPB.ScanOrBuilder

getStopRow

public com.google.protobuf.ByteString getStopRow()
optional bytes stop_row = 4;

Specified by:
getStopRow in interface ClientPB.ScanOrBuilder

hasFilter

public boolean hasFilter()
optional .Filter filter = 5;

Specified by:
hasFilter in interface ClientPB.ScanOrBuilder

getFilter

public FilterPB.Filter getFilter()
optional .Filter filter = 5;

Specified by:
getFilter in interface ClientPB.ScanOrBuilder

hasTimeRange

public boolean hasTimeRange()
optional .TimeRange time_range = 6;

Specified by:
hasTimeRange in interface ClientPB.ScanOrBuilder

getTimeRange

public HBasePB.TimeRange getTimeRange()
optional .TimeRange time_range = 6;

Specified by:
getTimeRange in interface ClientPB.ScanOrBuilder

hasMaxVersions

public boolean hasMaxVersions()
optional uint32 max_versions = 7 [default = 1];

Specified by:
hasMaxVersions in interface ClientPB.ScanOrBuilder

getMaxVersions

public int getMaxVersions()
optional uint32 max_versions = 7 [default = 1];

Specified by:
getMaxVersions in interface ClientPB.ScanOrBuilder

hasCacheBlocks

public boolean hasCacheBlocks()
optional bool cache_blocks = 8 [default = true];

Specified by:
hasCacheBlocks in interface ClientPB.ScanOrBuilder

getCacheBlocks

public boolean getCacheBlocks()
optional bool cache_blocks = 8 [default = true];

Specified by:
getCacheBlocks in interface ClientPB.ScanOrBuilder

hasBatchSize

public boolean hasBatchSize()
optional uint32 batch_size = 9;

Specified by:
hasBatchSize in interface ClientPB.ScanOrBuilder

getBatchSize

public int getBatchSize()
optional uint32 batch_size = 9;

Specified by:
getBatchSize in interface ClientPB.ScanOrBuilder

hasMaxResultSize

public boolean hasMaxResultSize()
optional uint64 max_result_size = 10;

Specified by:
hasMaxResultSize in interface ClientPB.ScanOrBuilder

getMaxResultSize

public long getMaxResultSize()
optional uint64 max_result_size = 10;

Specified by:
getMaxResultSize in interface ClientPB.ScanOrBuilder

hasStoreLimit

public boolean hasStoreLimit()
optional uint32 store_limit = 11;

Specified by:
hasStoreLimit in interface ClientPB.ScanOrBuilder

getStoreLimit

public int getStoreLimit()
optional uint32 store_limit = 11;

Specified by:
getStoreLimit in interface ClientPB.ScanOrBuilder

hasStoreOffset

public boolean hasStoreOffset()
optional uint32 store_offset = 12;

Specified by:
hasStoreOffset in interface ClientPB.ScanOrBuilder

getStoreOffset

public int getStoreOffset()
optional uint32 store_offset = 12;

Specified by:
getStoreOffset in interface ClientPB.ScanOrBuilder

hasLoadColumnFamiliesOnDemand

public boolean hasLoadColumnFamiliesOnDemand()
optional bool load_column_families_on_demand = 13;
 DO NOT add defaults to load_column_families_on_demand. 
 

Specified by:
hasLoadColumnFamiliesOnDemand in interface ClientPB.ScanOrBuilder

getLoadColumnFamiliesOnDemand

public boolean getLoadColumnFamiliesOnDemand()
optional bool load_column_families_on_demand = 13;
 DO NOT add defaults to load_column_families_on_demand. 
 

Specified by:
getLoadColumnFamiliesOnDemand in interface ClientPB.ScanOrBuilder

hasSmall

public boolean hasSmall()
optional bool small = 14;

Specified by:
hasSmall in interface ClientPB.ScanOrBuilder

getSmall

public boolean getSmall()
optional bool small = 14;

Specified by:
getSmall in interface ClientPB.ScanOrBuilder

isInitialized

public final boolean isInitialized()
Specified by:
isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
Specified by:
writeTo in interface com.google.protobuf.MessageLite
Throws:
IOException

getSerializedSize

public int getSerializedSize()
Specified by:
getSerializedSize in interface com.google.protobuf.MessageLite

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException
Overrides:
writeReplace in class com.google.protobuf.GeneratedMessageLite
Throws:
ObjectStreamException

parseFrom

public static ClientPB.Scan parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
Throws:
com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientPB.Scan parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
Throws:
com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientPB.Scan parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
Throws:
com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientPB.Scan parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
Throws:
com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientPB.Scan parseFrom(InputStream input)
                               throws IOException
Throws:
IOException

parseFrom

public static ClientPB.Scan parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
Throws:
IOException

parseDelimitedFrom

public static ClientPB.Scan parseDelimitedFrom(InputStream input)
                                        throws IOException
Throws:
IOException

parseDelimitedFrom

public static ClientPB.Scan parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
Throws:
IOException

parseFrom

public static ClientPB.Scan parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException
Throws:
IOException

parseFrom

public static ClientPB.Scan parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
Throws:
IOException

newBuilder

public static ClientPB.Scan.Builder newBuilder()

newBuilderForType

public ClientPB.Scan.Builder newBuilderForType()
Specified by:
newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ClientPB.Scan.Builder newBuilder(ClientPB.Scan prototype)

toBuilder

public ClientPB.Scan.Builder toBuilder()
Specified by:
toBuilder in interface com.google.protobuf.MessageLite


Copyright © 2010-2015, The Async HBase Authors