org.apache.hadoop.hbase.protobuf.generated
Class ClientProtos.Scan

java.lang.Object
  com.google.protobuf.AbstractMessageLite
      com.google.protobuf.AbstractMessage
          com.google.protobuf.GeneratedMessage
              org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Scan

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ClientProtos.ScanOrBuilder

Enclosing class:

ClientProtos

public static final class ClientProtos.Scan
extends com.google.protobuf.GeneratedMessage
implements ClientProtos.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

ClientProtos.Scan.Builder Protobuf type Scan

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

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 com.google.protobuf.Parser<ClientProtos.Scan>	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

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

boolean	equals(Object obj)
HBaseProtos.NameBytesPair	getAttribute(int index) repeated .NameBytesPair attribute = 2;
int	getAttributeCount() repeated .NameBytesPair attribute = 2;
List<HBaseProtos.NameBytesPair>	getAttributeList() repeated .NameBytesPair attribute = 2;
HBaseProtos.NameBytesPairOrBuilder	getAttributeOrBuilder(int index) repeated .NameBytesPair attribute = 2;
List<? extends HBaseProtos.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;
ClientProtos.Column	getColumn(int index) repeated .Column column = 1;
int	getColumnCount() repeated .Column column = 1;
List<ClientProtos.Column>	getColumnList() repeated .Column column = 1;
ClientProtos.ColumnOrBuilder	getColumnOrBuilder(int index) repeated .Column column = 1;
List<? extends ClientProtos.ColumnOrBuilder>	getColumnOrBuilderList() repeated .Column column = 1;
static ClientProtos.Scan	getDefaultInstance()
ClientProtos.Scan	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FilterProtos.Filter	getFilter() optional .Filter filter = 5;
FilterProtos.FilterOrBuilder	getFilterOrBuilder() 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<ClientProtos.Scan>	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 .TimeRange time_range = 6;
HBaseProtos.TimeRangeOrBuilder	getTimeRangeOrBuilder() optional .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	hasFilter() optional .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 .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(InputStream input)
static ClientProtos.Scan	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientProtos.Scan	parseFrom(byte[] data)
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(InputStream input)
static ClientProtos.Scan	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ClientProtos.Scan.Builder	toBuilder()
protected Object	writeReplace()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, hasField

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARSER

public static com.google.protobuf.Parser<ClientProtos.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

REVERSED_FIELD_NUMBER

public static final int REVERSED_FIELD_NUMBER

See Also:

Constant Field Values

CACHING_FIELD_NUMBER

public static final int CACHING_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static ClientProtos.Scan getDefaultInstance()

getDefaultInstanceForType

public ClientProtos.Scan getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getParserForType

public com.google.protobuf.Parser<ClientProtos.Scan> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getColumnList

public List<ClientProtos.Column> getColumnList()

repeated .Column column = 1;

Specified by:

getColumnList in interface ClientProtos.ScanOrBuilder

getColumnOrBuilderList

public List<? extends ClientProtos.ColumnOrBuilder> getColumnOrBuilderList()

repeated .Column column = 1;

Specified by:

getColumnOrBuilderList in interface ClientProtos.ScanOrBuilder

getColumnCount

public int getColumnCount()

repeated .Column column = 1;

Specified by:

getColumnCount in interface ClientProtos.ScanOrBuilder

getColumn

public ClientProtos.Column getColumn(int index)

repeated .Column column = 1;

Specified by:

getColumn in interface ClientProtos.ScanOrBuilder

getColumnOrBuilder

public ClientProtos.ColumnOrBuilder getColumnOrBuilder(int index)

repeated .Column column = 1;

Specified by:

getColumnOrBuilder in interface ClientProtos.ScanOrBuilder

getAttributeList

public List<HBaseProtos.NameBytesPair> getAttributeList()

repeated .NameBytesPair attribute = 2;

Specified by:

getAttributeList in interface ClientProtos.ScanOrBuilder

getAttributeOrBuilderList

public List<? extends HBaseProtos.NameBytesPairOrBuilder> getAttributeOrBuilderList()

repeated .NameBytesPair attribute = 2;

Specified by:

getAttributeOrBuilderList in interface ClientProtos.ScanOrBuilder

getAttributeCount

public int getAttributeCount()

repeated .NameBytesPair attribute = 2;

Specified by:

getAttributeCount in interface ClientProtos.ScanOrBuilder

getAttribute

public HBaseProtos.NameBytesPair getAttribute(int index)

repeated .NameBytesPair attribute = 2;

Specified by:

getAttribute in interface ClientProtos.ScanOrBuilder

getAttributeOrBuilder

public HBaseProtos.NameBytesPairOrBuilder getAttributeOrBuilder(int index)

repeated .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 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 com.google.protobuf.ByteString getStopRow()

optional bytes stop_row = 4;

Specified by:

getStopRow in interface ClientProtos.ScanOrBuilder

hasFilter

public boolean hasFilter()

optional .Filter filter = 5;

Specified by:

hasFilter in interface ClientProtos.ScanOrBuilder

getFilter

public FilterProtos.Filter getFilter()

optional .Filter filter = 5;

Specified by:

getFilter in interface ClientProtos.ScanOrBuilder

getFilterOrBuilder

public FilterProtos.FilterOrBuilder getFilterOrBuilder()

optional .Filter filter = 5;

Specified by:

getFilterOrBuilder in interface ClientProtos.ScanOrBuilder

hasTimeRange

public boolean hasTimeRange()

optional .TimeRange time_range = 6;

Specified by:

hasTimeRange in interface ClientProtos.ScanOrBuilder

getTimeRange

public HBaseProtos.TimeRange getTimeRange()

optional .TimeRange time_range = 6;

Specified by:

getTimeRange in interface ClientProtos.ScanOrBuilder

getTimeRangeOrBuilder

public HBaseProtos.TimeRangeOrBuilder getTimeRangeOrBuilder()

optional .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()

optional bool load_column_families_on_demand = 13;

 DO NOT add defaults to load_column_families_on_demand. 
 

Specified by:

hasLoadColumnFamiliesOnDemand in interface ClientProtos.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 ClientProtos.ScanOrBuilder

hasSmall

public boolean hasSmall()

optional bool small = 14;

Specified by:

hasSmall in interface ClientProtos.ScanOrBuilder

getSmall

public boolean getSmall()

optional bool small = 14;

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.AbstractMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.AbstractMessage

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Overrides:

writeReplace in class com.google.protobuf.GeneratedMessage

Throws:

ObjectStreamException

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ClientProtos.Scan parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientProtos.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 ClientProtos.Scan parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientProtos.Scan parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static ClientProtos.Scan parseFrom(InputStream input,
                                          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,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static ClientProtos.Scan parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilder

public static ClientProtos.Scan.Builder newBuilder()

newBuilderForType

public ClientProtos.Scan.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

toBuilder

public ClientProtos.Scan.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ClientProtos.Scan.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage