org.apache.hadoop.hbase.protobuf.generated

Class ClientProtos.ScanRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<BuilderType>

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>

org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, ClientProtos.ScanRequestOrBuilder

Enclosing class:

ClientProtos.ScanRequest

@Generated(value="proto")
public static final class ClientProtos.ScanRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>
implements ClientProtos.ScanRequestOrBuilder

Protobuf type hbase.pb.ScanRequest

 A scan request. Initially, it should specify a scan. Later on, you
 can use the scanner id returned to fetch result batches with a different
 scan request.

 The scanner will remain open if there are more results, and it's not
 asked to be closed explicitly.

 You can fetch the results and ask the scanner to be closed to save
 a trip if you are not interested in remaining results.
 

Method Summary

Modifier and Type	Method and Description
ClientProtos.ScanRequest	build()
ClientProtos.ScanRequest	buildPartial()
ClientProtos.ScanRequest.Builder	clear()
ClientProtos.ScanRequest.Builder	clearClientHandlesHeartbeats() optional bool client_handles_heartbeats = 8;
ClientProtos.ScanRequest.Builder	clearClientHandlesPartials() optional bool client_handles_partials = 7;
ClientProtos.ScanRequest.Builder	clearCloseScanner() optional bool close_scanner = 5;
ClientProtos.ScanRequest.Builder	clearLimitOfRows() optional uint32 limit_of_rows = 11 [default = 0];
ClientProtos.ScanRequest.Builder	clearNextCallSeq() optional uint64 next_call_seq = 6;
ClientProtos.ScanRequest.Builder	clearNumberOfRows() optional uint32 number_of_rows = 4;
ClientProtos.ScanRequest.Builder	clearRegion() optional .hbase.pb.RegionSpecifier region = 1;
ClientProtos.ScanRequest.Builder	clearRenew() optional bool renew = 10 [default = false];
ClientProtos.ScanRequest.Builder	clearScan() optional .hbase.pb.Scan scan = 2;
ClientProtos.ScanRequest.Builder	clearScannerId() optional uint64 scanner_id = 3;
ClientProtos.ScanRequest.Builder	clearTrackScanMetrics() optional bool track_scan_metrics = 9;
ClientProtos.ScanRequest.Builder	clone()
boolean	getClientHandlesHeartbeats() optional bool client_handles_heartbeats = 8;
boolean	getClientHandlesPartials() optional bool client_handles_partials = 7;
boolean	getCloseScanner() optional bool close_scanner = 5;
ClientProtos.ScanRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getLimitOfRows() optional uint32 limit_of_rows = 11 [default = 0];
long	getNextCallSeq() optional uint64 next_call_seq = 6;
int	getNumberOfRows() optional uint32 number_of_rows = 4;
HBaseProtos.RegionSpecifier	getRegion() optional .hbase.pb.RegionSpecifier region = 1;
HBaseProtos.RegionSpecifier.Builder	getRegionBuilder() optional .hbase.pb.RegionSpecifier region = 1;
HBaseProtos.RegionSpecifierOrBuilder	getRegionOrBuilder() optional .hbase.pb.RegionSpecifier region = 1;
boolean	getRenew() optional bool renew = 10 [default = false];
ClientProtos.Scan	getScan() optional .hbase.pb.Scan scan = 2;
ClientProtos.Scan.Builder	getScanBuilder() optional .hbase.pb.Scan scan = 2;
long	getScannerId() optional uint64 scanner_id = 3;
ClientProtos.ScanOrBuilder	getScanOrBuilder() optional .hbase.pb.Scan scan = 2;
boolean	getTrackScanMetrics() optional bool track_scan_metrics = 9;
boolean	hasClientHandlesHeartbeats() optional bool client_handles_heartbeats = 8;
boolean	hasClientHandlesPartials() optional bool client_handles_partials = 7;
boolean	hasCloseScanner() optional bool close_scanner = 5;
boolean	hasLimitOfRows() optional uint32 limit_of_rows = 11 [default = 0];
boolean	hasNextCallSeq() optional uint64 next_call_seq = 6;
boolean	hasNumberOfRows() optional uint32 number_of_rows = 4;
boolean	hasRegion() optional .hbase.pb.RegionSpecifier region = 1;
boolean	hasRenew() optional bool renew = 10 [default = false];
boolean	hasScan() optional .hbase.pb.Scan scan = 2;
boolean	hasScannerId() optional uint64 scanner_id = 3;
boolean	hasTrackScanMetrics() optional bool track_scan_metrics = 9;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ClientProtos.ScanRequest.Builder	mergeFrom(ClientProtos.ScanRequest other)
ClientProtos.ScanRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ClientProtos.ScanRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ClientProtos.ScanRequest.Builder	mergeRegion(HBaseProtos.RegionSpecifier value) optional .hbase.pb.RegionSpecifier region = 1;
ClientProtos.ScanRequest.Builder	mergeScan(ClientProtos.Scan value) optional .hbase.pb.Scan scan = 2;
ClientProtos.ScanRequest.Builder	setClientHandlesHeartbeats(boolean value) optional bool client_handles_heartbeats = 8;
ClientProtos.ScanRequest.Builder	setClientHandlesPartials(boolean value) optional bool client_handles_partials = 7;
ClientProtos.ScanRequest.Builder	setCloseScanner(boolean value) optional bool close_scanner = 5;
ClientProtos.ScanRequest.Builder	setLimitOfRows(int value) optional uint32 limit_of_rows = 11 [default = 0];
ClientProtos.ScanRequest.Builder	setNextCallSeq(long value) optional uint64 next_call_seq = 6;
ClientProtos.ScanRequest.Builder	setNumberOfRows(int value) optional uint32 number_of_rows = 4;
ClientProtos.ScanRequest.Builder	setRegion(HBaseProtos.RegionSpecifier.Builder builderForValue) optional .hbase.pb.RegionSpecifier region = 1;
ClientProtos.ScanRequest.Builder	setRegion(HBaseProtos.RegionSpecifier value) optional .hbase.pb.RegionSpecifier region = 1;
ClientProtos.ScanRequest.Builder	setRenew(boolean value) optional bool renew = 10 [default = false];
ClientProtos.ScanRequest.Builder	setScan(ClientProtos.Scan.Builder builderForValue) optional .hbase.pb.Scan scan = 2;
ClientProtos.ScanRequest.Builder	setScan(ClientProtos.Scan value) optional .hbase.pb.Scan scan = 2;
ClientProtos.ScanRequest.Builder	setScannerId(long value) optional uint64 scanner_id = 3;
ClientProtos.ScanRequest.Builder	setTrackScanMetrics(boolean value) optional bool track_scan_metrics = 9;

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

addRepeatedField, clearField, getAllFields, getField, getFieldBuilder, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields

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

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

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

addAll, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

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.Builder<ClientProtos.ScanRequest.Builder>

clear

public ClientProtos.ScanRequest.Builder clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>

clone

public ClientProtos.ScanRequest.Builder clone()

Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>

getDefaultInstanceForType

public ClientProtos.ScanRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ClientProtos.ScanRequest build()

Specified by:

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

Specified by:

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

buildPartial

public ClientProtos.ScanRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public ClientProtos.ScanRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

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

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>

mergeFrom

public ClientProtos.ScanRequest.Builder mergeFrom(ClientProtos.ScanRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>

mergeFrom

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

Specified by:

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

Specified by:

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

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>

Throws:

IOException

hasRegion

public boolean hasRegion()

optional .hbase.pb.RegionSpecifier region = 1;

Specified by:

hasRegion in interface ClientProtos.ScanRequestOrBuilder

getRegion

public HBaseProtos.RegionSpecifier getRegion()

optional .hbase.pb.RegionSpecifier region = 1;

Specified by:

getRegion in interface ClientProtos.ScanRequestOrBuilder

setRegion

public ClientProtos.ScanRequest.Builder setRegion(HBaseProtos.RegionSpecifier value)

optional .hbase.pb.RegionSpecifier region = 1;

setRegion

public ClientProtos.ScanRequest.Builder setRegion(HBaseProtos.RegionSpecifier.Builder builderForValue)

optional .hbase.pb.RegionSpecifier region = 1;

mergeRegion

public ClientProtos.ScanRequest.Builder mergeRegion(HBaseProtos.RegionSpecifier value)

optional .hbase.pb.RegionSpecifier region = 1;

clearRegion

public ClientProtos.ScanRequest.Builder clearRegion()

optional .hbase.pb.RegionSpecifier region = 1;

getRegionBuilder

public HBaseProtos.RegionSpecifier.Builder getRegionBuilder()

optional .hbase.pb.RegionSpecifier region = 1;

getRegionOrBuilder

public HBaseProtos.RegionSpecifierOrBuilder getRegionOrBuilder()

optional .hbase.pb.RegionSpecifier region = 1;

Specified by:

getRegionOrBuilder in interface ClientProtos.ScanRequestOrBuilder

hasScan

public boolean hasScan()

optional .hbase.pb.Scan scan = 2;

Specified by:

hasScan in interface ClientProtos.ScanRequestOrBuilder

getScan

public ClientProtos.Scan getScan()

optional .hbase.pb.Scan scan = 2;

Specified by:

getScan in interface ClientProtos.ScanRequestOrBuilder

setScan

public ClientProtos.ScanRequest.Builder setScan(ClientProtos.Scan value)

optional .hbase.pb.Scan scan = 2;

setScan

public ClientProtos.ScanRequest.Builder setScan(ClientProtos.Scan.Builder builderForValue)

optional .hbase.pb.Scan scan = 2;

mergeScan

public ClientProtos.ScanRequest.Builder mergeScan(ClientProtos.Scan value)

optional .hbase.pb.Scan scan = 2;

clearScan

public ClientProtos.ScanRequest.Builder clearScan()

optional .hbase.pb.Scan scan = 2;

getScanBuilder

public ClientProtos.Scan.Builder getScanBuilder()

optional .hbase.pb.Scan scan = 2;

getScanOrBuilder

public ClientProtos.ScanOrBuilder getScanOrBuilder()

optional .hbase.pb.Scan scan = 2;

Specified by:

getScanOrBuilder in interface ClientProtos.ScanRequestOrBuilder

hasScannerId

public boolean hasScannerId()

optional uint64 scanner_id = 3;

Specified by:

hasScannerId in interface ClientProtos.ScanRequestOrBuilder

getScannerId

public long getScannerId()

optional uint64 scanner_id = 3;

Specified by:

getScannerId in interface ClientProtos.ScanRequestOrBuilder

setScannerId

public ClientProtos.ScanRequest.Builder setScannerId(long value)

optional uint64 scanner_id = 3;

clearScannerId

public ClientProtos.ScanRequest.Builder clearScannerId()

optional uint64 scanner_id = 3;

hasNumberOfRows

public boolean hasNumberOfRows()

optional uint32 number_of_rows = 4;

Specified by:

hasNumberOfRows in interface ClientProtos.ScanRequestOrBuilder

getNumberOfRows

public int getNumberOfRows()

optional uint32 number_of_rows = 4;

Specified by:

getNumberOfRows in interface ClientProtos.ScanRequestOrBuilder

setNumberOfRows

public ClientProtos.ScanRequest.Builder setNumberOfRows(int value)

optional uint32 number_of_rows = 4;

clearNumberOfRows

public ClientProtos.ScanRequest.Builder clearNumberOfRows()

optional uint32 number_of_rows = 4;

hasCloseScanner

public boolean hasCloseScanner()

optional bool close_scanner = 5;

Specified by:

hasCloseScanner in interface ClientProtos.ScanRequestOrBuilder

getCloseScanner

public boolean getCloseScanner()

optional bool close_scanner = 5;

Specified by:

getCloseScanner in interface ClientProtos.ScanRequestOrBuilder

setCloseScanner

public ClientProtos.ScanRequest.Builder setCloseScanner(boolean value)

optional bool close_scanner = 5;

clearCloseScanner

public ClientProtos.ScanRequest.Builder clearCloseScanner()

optional bool close_scanner = 5;

hasNextCallSeq

public boolean hasNextCallSeq()

optional uint64 next_call_seq = 6;

Specified by:

hasNextCallSeq in interface ClientProtos.ScanRequestOrBuilder

getNextCallSeq

public long getNextCallSeq()

optional uint64 next_call_seq = 6;

Specified by:

getNextCallSeq in interface ClientProtos.ScanRequestOrBuilder

setNextCallSeq

public ClientProtos.ScanRequest.Builder setNextCallSeq(long value)

optional uint64 next_call_seq = 6;

clearNextCallSeq

public ClientProtos.ScanRequest.Builder clearNextCallSeq()

optional uint64 next_call_seq = 6;

hasClientHandlesPartials

public boolean hasClientHandlesPartials()

optional bool client_handles_partials = 7;

Specified by:

hasClientHandlesPartials in interface ClientProtos.ScanRequestOrBuilder

getClientHandlesPartials

public boolean getClientHandlesPartials()

optional bool client_handles_partials = 7;

Specified by:

getClientHandlesPartials in interface ClientProtos.ScanRequestOrBuilder

setClientHandlesPartials

public ClientProtos.ScanRequest.Builder setClientHandlesPartials(boolean value)

optional bool client_handles_partials = 7;

clearClientHandlesPartials

public ClientProtos.ScanRequest.Builder clearClientHandlesPartials()

optional bool client_handles_partials = 7;

hasClientHandlesHeartbeats

public boolean hasClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

Specified by:

hasClientHandlesHeartbeats in interface ClientProtos.ScanRequestOrBuilder

getClientHandlesHeartbeats

public boolean getClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

Specified by:

getClientHandlesHeartbeats in interface ClientProtos.ScanRequestOrBuilder

setClientHandlesHeartbeats

public ClientProtos.ScanRequest.Builder setClientHandlesHeartbeats(boolean value)

optional bool client_handles_heartbeats = 8;

clearClientHandlesHeartbeats

public ClientProtos.ScanRequest.Builder clearClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

hasTrackScanMetrics

public boolean hasTrackScanMetrics()

optional bool track_scan_metrics = 9;

Specified by:

hasTrackScanMetrics in interface ClientProtos.ScanRequestOrBuilder

getTrackScanMetrics

public boolean getTrackScanMetrics()

optional bool track_scan_metrics = 9;

Specified by:

getTrackScanMetrics in interface ClientProtos.ScanRequestOrBuilder

setTrackScanMetrics

public ClientProtos.ScanRequest.Builder setTrackScanMetrics(boolean value)

optional bool track_scan_metrics = 9;

clearTrackScanMetrics

public ClientProtos.ScanRequest.Builder clearTrackScanMetrics()

optional bool track_scan_metrics = 9;

hasRenew

public boolean hasRenew()

optional bool renew = 10 [default = false];

Specified by:

hasRenew in interface ClientProtos.ScanRequestOrBuilder

getRenew

public boolean getRenew()

optional bool renew = 10 [default = false];

Specified by:

getRenew in interface ClientProtos.ScanRequestOrBuilder

setRenew

public ClientProtos.ScanRequest.Builder setRenew(boolean value)

optional bool renew = 10 [default = false];

clearRenew

public ClientProtos.ScanRequest.Builder clearRenew()

optional bool renew = 10 [default = false];

hasLimitOfRows

public boolean hasLimitOfRows()

optional uint32 limit_of_rows = 11 [default = 0];

 if we have returned limit_of_rows rows to client, then close the scanner.
 

Specified by:

hasLimitOfRows in interface ClientProtos.ScanRequestOrBuilder

getLimitOfRows

public int getLimitOfRows()

optional uint32 limit_of_rows = 11 [default = 0];

 if we have returned limit_of_rows rows to client, then close the scanner.
 

Specified by:

getLimitOfRows in interface ClientProtos.ScanRequestOrBuilder

setLimitOfRows

public ClientProtos.ScanRequest.Builder setLimitOfRows(int value)

optional uint32 limit_of_rows = 11 [default = 0];

 if we have returned limit_of_rows rows to client, then close the scanner.
 

clearLimitOfRows

public ClientProtos.ScanRequest.Builder clearLimitOfRows()

optional uint32 limit_of_rows = 11 [default = 0];

 if we have returned limit_of_rows rows to client, then close the scanner.