public static final class ClientProtos.ScanRequest.Builder extends <any> implements ClientProtos.ScanRequestOrBuilder
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.
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 |
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 |
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() |
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 |
hasClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8; |
boolean |
hasClientHandlesPartials()
optional bool client_handles_partials = 7; |
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 .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; |
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
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 |
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; |
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
public ClientProtos.ScanRequest.Builder clear()
public ClientProtos.ScanRequest.Builder clone()
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
public ClientProtos.ScanRequest getDefaultInstanceForType()
public ClientProtos.ScanRequest build()
public ClientProtos.ScanRequest buildPartial()
public ClientProtos.ScanRequest.Builder mergeFrom(com.google.protobuf.Message other)
public final boolean isInitialized()
public ClientProtos.ScanRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public boolean hasRegion()
optional .hbase.pb.RegionSpecifier region = 1;
hasRegion
in interface ClientProtos.ScanRequestOrBuilder
public HBaseProtos.RegionSpecifier getRegion()
optional .hbase.pb.RegionSpecifier region = 1;
getRegion
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setRegion(HBaseProtos.RegionSpecifier value)
optional .hbase.pb.RegionSpecifier region = 1;
public ClientProtos.ScanRequest.Builder setRegion(HBaseProtos.RegionSpecifier.Builder builderForValue)
optional .hbase.pb.RegionSpecifier region = 1;
public ClientProtos.ScanRequest.Builder mergeRegion(HBaseProtos.RegionSpecifier value)
optional .hbase.pb.RegionSpecifier region = 1;
public ClientProtos.ScanRequest.Builder clearRegion()
optional .hbase.pb.RegionSpecifier region = 1;
public HBaseProtos.RegionSpecifier.Builder getRegionBuilder()
optional .hbase.pb.RegionSpecifier region = 1;
public HBaseProtos.RegionSpecifierOrBuilder getRegionOrBuilder()
optional .hbase.pb.RegionSpecifier region = 1;
getRegionOrBuilder
in interface ClientProtos.ScanRequestOrBuilder
public boolean hasScan()
optional .hbase.pb.Scan scan = 2;
hasScan
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.Scan getScan()
optional .hbase.pb.Scan scan = 2;
getScan
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setScan(ClientProtos.Scan value)
optional .hbase.pb.Scan scan = 2;
public ClientProtos.ScanRequest.Builder setScan(ClientProtos.Scan.Builder builderForValue)
optional .hbase.pb.Scan scan = 2;
public ClientProtos.ScanRequest.Builder mergeScan(ClientProtos.Scan value)
optional .hbase.pb.Scan scan = 2;
public ClientProtos.ScanRequest.Builder clearScan()
optional .hbase.pb.Scan scan = 2;
public ClientProtos.Scan.Builder getScanBuilder()
optional .hbase.pb.Scan scan = 2;
public ClientProtos.ScanOrBuilder getScanOrBuilder()
optional .hbase.pb.Scan scan = 2;
getScanOrBuilder
in interface ClientProtos.ScanRequestOrBuilder
public boolean hasScannerId()
optional uint64 scanner_id = 3;
hasScannerId
in interface ClientProtos.ScanRequestOrBuilder
public long getScannerId()
optional uint64 scanner_id = 3;
getScannerId
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setScannerId(long value)
optional uint64 scanner_id = 3;
public ClientProtos.ScanRequest.Builder clearScannerId()
optional uint64 scanner_id = 3;
public boolean hasNumberOfRows()
optional uint32 number_of_rows = 4;
hasNumberOfRows
in interface ClientProtos.ScanRequestOrBuilder
public int getNumberOfRows()
optional uint32 number_of_rows = 4;
getNumberOfRows
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setNumberOfRows(int value)
optional uint32 number_of_rows = 4;
public ClientProtos.ScanRequest.Builder clearNumberOfRows()
optional uint32 number_of_rows = 4;
public boolean hasCloseScanner()
optional bool close_scanner = 5;
hasCloseScanner
in interface ClientProtos.ScanRequestOrBuilder
public boolean getCloseScanner()
optional bool close_scanner = 5;
getCloseScanner
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setCloseScanner(boolean value)
optional bool close_scanner = 5;
public ClientProtos.ScanRequest.Builder clearCloseScanner()
optional bool close_scanner = 5;
public boolean hasNextCallSeq()
optional uint64 next_call_seq = 6;
hasNextCallSeq
in interface ClientProtos.ScanRequestOrBuilder
public long getNextCallSeq()
optional uint64 next_call_seq = 6;
getNextCallSeq
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setNextCallSeq(long value)
optional uint64 next_call_seq = 6;
public ClientProtos.ScanRequest.Builder clearNextCallSeq()
optional uint64 next_call_seq = 6;
public boolean hasClientHandlesPartials()
optional bool client_handles_partials = 7;
hasClientHandlesPartials
in interface ClientProtos.ScanRequestOrBuilder
public boolean getClientHandlesPartials()
optional bool client_handles_partials = 7;
getClientHandlesPartials
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setClientHandlesPartials(boolean value)
optional bool client_handles_partials = 7;
public ClientProtos.ScanRequest.Builder clearClientHandlesPartials()
optional bool client_handles_partials = 7;
public boolean hasClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8;
hasClientHandlesHeartbeats
in interface ClientProtos.ScanRequestOrBuilder
public boolean getClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8;
getClientHandlesHeartbeats
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setClientHandlesHeartbeats(boolean value)
optional bool client_handles_heartbeats = 8;
public ClientProtos.ScanRequest.Builder clearClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8;
public boolean hasRenew()
optional bool renew = 10 [default = false];
hasRenew
in interface ClientProtos.ScanRequestOrBuilder
public boolean getRenew()
optional bool renew = 10 [default = false];
getRenew
in interface ClientProtos.ScanRequestOrBuilder
public ClientProtos.ScanRequest.Builder setRenew(boolean value)
optional bool renew = 10 [default = false];
public ClientProtos.ScanRequest.Builder clearRenew()
optional bool renew = 10 [default = false];