org.hbase.async.generated
Class ClientPB.Scan.Builder

java.lang.Object
  com.google.protobuf.AbstractMessageLite.Builder<BuilderType>
      com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder>
          org.hbase.async.generated.ClientPB.Scan.Builder

All Implemented Interfaces:

com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable, ClientPB.ScanOrBuilder

Enclosing class:

ClientPB.Scan

public static final class ClientPB.Scan.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder>
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.
 

Method Summary

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	build()
ClientPB.Scan	buildPartial()
ClientPB.Scan.Builder	clear()
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	clearColumn() repeated .Column column = 1;
ClientPB.Scan.Builder	clearFilter() optional .Filter filter = 5;
ClientPB.Scan.Builder	clearLoadColumnFamiliesOnDemand() optional bool load_column_families_on_demand = 13;
ClientPB.Scan.Builder	clearMaxResultSize() optional uint64 max_result_size = 10;
ClientPB.Scan.Builder	clearMaxVersions() optional uint32 max_versions = 7 [default = 1];
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;
ClientPB.Scan.Builder	clone()
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];
ClientPB.Column	getColumn(int index) repeated .Column column = 1;
int	getColumnCount() repeated .Column column = 1;
List<ClientPB.Column>	getColumnList() repeated .Column column = 1;
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];
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()
ClientPB.Scan.Builder	mergeFilter(FilterPB.Filter value) optional .Filter filter = 5;
ClientPB.Scan.Builder	mergeFrom(ClientPB.Scan other)
ClientPB.Scan.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
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	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) optional bool load_column_families_on_demand = 13;
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	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;

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

clear

public ClientPB.Scan.Builder clear()

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder>

clone

public ClientPB.Scan.Builder clone()

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder>

getDefaultInstanceForType

public ClientPB.Scan getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

getDefaultInstanceForType in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder>

build

public ClientPB.Scan build()

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ClientPB.Scan buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ClientPB.Scan.Builder mergeFrom(ClientPB.Scan other)

Specified by:

mergeFrom in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.Scan,ClientPB.Scan.Builder>

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

mergeFrom

public ClientPB.Scan.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessageLite.Builder<ClientPB.Scan.Builder>

Throws:

IOException

getColumnList

public List<ClientPB.Column> getColumnList()

repeated .Column column = 1;

Specified by:

getColumnList in interface ClientPB.ScanOrBuilder

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

setColumn

public ClientPB.Scan.Builder setColumn(int index,
                                       ClientPB.Column value)

repeated .Column column = 1;

setColumn

public ClientPB.Scan.Builder setColumn(int index,
                                       ClientPB.Column.Builder builderForValue)

repeated .Column column = 1;

addColumn

public ClientPB.Scan.Builder addColumn(ClientPB.Column value)

repeated .Column column = 1;

addColumn

public ClientPB.Scan.Builder addColumn(int index,
                                       ClientPB.Column value)

repeated .Column column = 1;

addColumn

public ClientPB.Scan.Builder addColumn(ClientPB.Column.Builder builderForValue)

repeated .Column column = 1;

addColumn

public ClientPB.Scan.Builder addColumn(int index,
                                       ClientPB.Column.Builder builderForValue)

repeated .Column column = 1;

addAllColumn

public ClientPB.Scan.Builder addAllColumn(Iterable<? extends ClientPB.Column> values)

repeated .Column column = 1;

clearColumn

public ClientPB.Scan.Builder clearColumn()

repeated .Column column = 1;

removeColumn

public ClientPB.Scan.Builder removeColumn(int index)

repeated .Column column = 1;

getAttributeList

public List<HBasePB.NameBytesPair> getAttributeList()

repeated .NameBytesPair attribute = 2;

Specified by:

getAttributeList in interface ClientPB.ScanOrBuilder

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

setAttribute

public ClientPB.Scan.Builder setAttribute(int index,
                                          HBasePB.NameBytesPair value)

repeated .NameBytesPair attribute = 2;

setAttribute

public ClientPB.Scan.Builder setAttribute(int index,
                                          HBasePB.NameBytesPair.Builder builderForValue)

repeated .NameBytesPair attribute = 2;

addAttribute

public ClientPB.Scan.Builder addAttribute(HBasePB.NameBytesPair value)

repeated .NameBytesPair attribute = 2;

addAttribute

public ClientPB.Scan.Builder addAttribute(int index,
                                          HBasePB.NameBytesPair value)

repeated .NameBytesPair attribute = 2;

addAttribute

public ClientPB.Scan.Builder addAttribute(HBasePB.NameBytesPair.Builder builderForValue)

repeated .NameBytesPair attribute = 2;

addAttribute

public ClientPB.Scan.Builder addAttribute(int index,
                                          HBasePB.NameBytesPair.Builder builderForValue)

repeated .NameBytesPair attribute = 2;

addAllAttribute

public ClientPB.Scan.Builder addAllAttribute(Iterable<? extends HBasePB.NameBytesPair> values)

repeated .NameBytesPair attribute = 2;

clearAttribute

public ClientPB.Scan.Builder clearAttribute()

repeated .NameBytesPair attribute = 2;

removeAttribute

public ClientPB.Scan.Builder removeAttribute(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

setStartRow

public ClientPB.Scan.Builder setStartRow(com.google.protobuf.ByteString value)

optional bytes start_row = 3;

clearStartRow

public ClientPB.Scan.Builder clearStartRow()

optional bytes start_row = 3;

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

setStopRow

public ClientPB.Scan.Builder setStopRow(com.google.protobuf.ByteString value)

optional bytes stop_row = 4;

clearStopRow

public ClientPB.Scan.Builder clearStopRow()

optional bytes stop_row = 4;

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

setFilter

public ClientPB.Scan.Builder setFilter(FilterPB.Filter value)

optional .Filter filter = 5;

setFilter

public ClientPB.Scan.Builder setFilter(FilterPB.Filter.Builder builderForValue)

optional .Filter filter = 5;

mergeFilter

public ClientPB.Scan.Builder mergeFilter(FilterPB.Filter value)

optional .Filter filter = 5;

clearFilter

public ClientPB.Scan.Builder clearFilter()

optional .Filter filter = 5;

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

setTimeRange

public ClientPB.Scan.Builder setTimeRange(HBasePB.TimeRange value)

optional .TimeRange time_range = 6;

setTimeRange

public ClientPB.Scan.Builder setTimeRange(HBasePB.TimeRange.Builder builderForValue)

optional .TimeRange time_range = 6;

mergeTimeRange

public ClientPB.Scan.Builder mergeTimeRange(HBasePB.TimeRange value)

optional .TimeRange time_range = 6;

clearTimeRange

public ClientPB.Scan.Builder clearTimeRange()

optional .TimeRange time_range = 6;

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

setMaxVersions

public ClientPB.Scan.Builder setMaxVersions(int value)

optional uint32 max_versions = 7 [default = 1];

clearMaxVersions

public ClientPB.Scan.Builder clearMaxVersions()

optional uint32 max_versions = 7 [default = 1];

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

setCacheBlocks

public ClientPB.Scan.Builder setCacheBlocks(boolean value)

optional bool cache_blocks = 8 [default = true];

clearCacheBlocks

public ClientPB.Scan.Builder clearCacheBlocks()

optional bool cache_blocks = 8 [default = true];

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

setBatchSize

public ClientPB.Scan.Builder setBatchSize(int value)

optional uint32 batch_size = 9;

clearBatchSize

public ClientPB.Scan.Builder clearBatchSize()

optional uint32 batch_size = 9;

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

setMaxResultSize

public ClientPB.Scan.Builder setMaxResultSize(long value)

optional uint64 max_result_size = 10;

clearMaxResultSize

public ClientPB.Scan.Builder clearMaxResultSize()

optional uint64 max_result_size = 10;

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

setStoreLimit

public ClientPB.Scan.Builder setStoreLimit(int value)

optional uint32 store_limit = 11;

clearStoreLimit

public ClientPB.Scan.Builder clearStoreLimit()

optional uint32 store_limit = 11;

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

setStoreOffset

public ClientPB.Scan.Builder setStoreOffset(int value)

optional uint32 store_offset = 12;

clearStoreOffset

public ClientPB.Scan.Builder clearStoreOffset()

optional uint32 store_offset = 12;

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

setLoadColumnFamiliesOnDemand

public ClientPB.Scan.Builder setLoadColumnFamiliesOnDemand(boolean value)

optional bool load_column_families_on_demand = 13;

 DO NOT add defaults to load_column_families_on_demand. 
 

clearLoadColumnFamiliesOnDemand

public ClientPB.Scan.Builder clearLoadColumnFamiliesOnDemand()

optional bool load_column_families_on_demand = 13;

 DO NOT add defaults to load_column_families_on_demand. 
 

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

setSmall

public ClientPB.Scan.Builder setSmall(boolean value)

optional bool small = 14;

clearSmall

public ClientPB.Scan.Builder clearSmall()

optional bool small = 14;