public static final class ClientPB.ScanRequest.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder> implements ClientPB.ScanRequestOrBuilder
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.Protobuf type
ScanRequest
Modifier and Type | Method and Description |
---|---|
ClientPB.ScanRequest.Builder |
clearCloseScanner()
optional bool close_scanner = 5; |
ClientPB.ScanRequest.Builder |
clearNextCallSeq()
optional uint64 next_call_seq = 6; |
ClientPB.ScanRequest.Builder |
clearNumberOfRows()
optional uint32 number_of_rows = 4; |
ClientPB.ScanRequest.Builder |
clearRegion()
optional .RegionSpecifier region = 1; |
ClientPB.ScanRequest.Builder |
clearScan()
optional .Scan scan = 2; |
ClientPB.ScanRequest.Builder |
clearScannerId()
optional uint64 scanner_id = 3; |
boolean |
getCloseScanner()
optional bool close_scanner = 5; |
long |
getNextCallSeq()
optional uint64 next_call_seq = 6; |
int |
getNumberOfRows()
optional uint32 number_of_rows = 4; |
HBasePB.RegionSpecifier |
getRegion()
optional .RegionSpecifier region = 1; |
ClientPB.Scan |
getScan()
optional .Scan scan = 2; |
long |
getScannerId()
optional uint64 scanner_id = 3; |
boolean |
hasCloseScanner()
optional bool close_scanner = 5; |
boolean |
hasNextCallSeq()
optional uint64 next_call_seq = 6; |
boolean |
hasNumberOfRows()
optional uint32 number_of_rows = 4; |
boolean |
hasRegion()
optional .RegionSpecifier region = 1; |
boolean |
hasScan()
optional .Scan scan = 2; |
boolean |
hasScannerId()
optional uint64 scanner_id = 3; |
ClientPB.ScanRequest.Builder |
mergeRegion(HBasePB.RegionSpecifier value)
optional .RegionSpecifier region = 1; |
ClientPB.ScanRequest.Builder |
mergeScan(ClientPB.Scan value)
optional .Scan scan = 2; |
ClientPB.ScanRequest.Builder |
setCloseScanner(boolean value)
optional bool close_scanner = 5; |
ClientPB.ScanRequest.Builder |
setNextCallSeq(long value)
optional uint64 next_call_seq = 6; |
ClientPB.ScanRequest.Builder |
setNumberOfRows(int value)
optional uint32 number_of_rows = 4; |
ClientPB.ScanRequest.Builder |
setRegion(HBasePB.RegionSpecifier.Builder builderForValue)
optional .RegionSpecifier region = 1; |
ClientPB.ScanRequest.Builder |
setRegion(HBasePB.RegionSpecifier value)
optional .RegionSpecifier region = 1; |
ClientPB.ScanRequest.Builder |
setScan(ClientPB.Scan.Builder builderForValue)
optional .Scan scan = 2; |
ClientPB.ScanRequest.Builder |
setScan(ClientPB.Scan value)
optional .Scan scan = 2; |
ClientPB.ScanRequest.Builder |
setScannerId(long value)
optional uint64 scanner_id = 3; |
build, buildPartial, clear, clone, copyOnWrite, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
public boolean hasRegion()
optional .RegionSpecifier region = 1;
hasRegion
in interface ClientPB.ScanRequestOrBuilder
public HBasePB.RegionSpecifier getRegion()
optional .RegionSpecifier region = 1;
getRegion
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.ScanRequest.Builder setRegion(HBasePB.RegionSpecifier value)
optional .RegionSpecifier region = 1;
public ClientPB.ScanRequest.Builder setRegion(HBasePB.RegionSpecifier.Builder builderForValue)
optional .RegionSpecifier region = 1;
public ClientPB.ScanRequest.Builder mergeRegion(HBasePB.RegionSpecifier value)
optional .RegionSpecifier region = 1;
public ClientPB.ScanRequest.Builder clearRegion()
optional .RegionSpecifier region = 1;
public boolean hasScan()
optional .Scan scan = 2;
hasScan
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.Scan getScan()
optional .Scan scan = 2;
getScan
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.ScanRequest.Builder setScan(ClientPB.Scan value)
optional .Scan scan = 2;
public ClientPB.ScanRequest.Builder setScan(ClientPB.Scan.Builder builderForValue)
optional .Scan scan = 2;
public ClientPB.ScanRequest.Builder mergeScan(ClientPB.Scan value)
optional .Scan scan = 2;
public ClientPB.ScanRequest.Builder clearScan()
optional .Scan scan = 2;
public boolean hasScannerId()
optional uint64 scanner_id = 3;
hasScannerId
in interface ClientPB.ScanRequestOrBuilder
public long getScannerId()
optional uint64 scanner_id = 3;
getScannerId
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.ScanRequest.Builder setScannerId(long value)
optional uint64 scanner_id = 3;
public ClientPB.ScanRequest.Builder clearScannerId()
optional uint64 scanner_id = 3;
public boolean hasNumberOfRows()
optional uint32 number_of_rows = 4;
hasNumberOfRows
in interface ClientPB.ScanRequestOrBuilder
public int getNumberOfRows()
optional uint32 number_of_rows = 4;
getNumberOfRows
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.ScanRequest.Builder setNumberOfRows(int value)
optional uint32 number_of_rows = 4;
public ClientPB.ScanRequest.Builder clearNumberOfRows()
optional uint32 number_of_rows = 4;
public boolean hasCloseScanner()
optional bool close_scanner = 5;
hasCloseScanner
in interface ClientPB.ScanRequestOrBuilder
public boolean getCloseScanner()
optional bool close_scanner = 5;
getCloseScanner
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.ScanRequest.Builder setCloseScanner(boolean value)
optional bool close_scanner = 5;
public ClientPB.ScanRequest.Builder clearCloseScanner()
optional bool close_scanner = 5;
public boolean hasNextCallSeq()
optional uint64 next_call_seq = 6;
hasNextCallSeq
in interface ClientPB.ScanRequestOrBuilder
public long getNextCallSeq()
optional uint64 next_call_seq = 6;
getNextCallSeq
in interface ClientPB.ScanRequestOrBuilder
public ClientPB.ScanRequest.Builder setNextCallSeq(long value)
optional uint64 next_call_seq = 6;
public ClientPB.ScanRequest.Builder clearNextCallSeq()
optional uint64 next_call_seq = 6;
Copyright © 2010–2018 The Async HBase Authors. All rights reserved.