public static final class ClientProtos.ScanRequest.Builder extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder> implements ClientProtos.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
hbase.pb.ScanRequest| Modifier and Type | Method and Description |
|---|---|
ClientProtos.ScanRequest.Builder |
addRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
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 |
clearField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field) |
ClientProtos.ScanRequest.Builder |
clearLimitOfRows()
if we have returned limit_of_rows rows to client, then close the scanner.
|
ClientProtos.ScanRequest.Builder |
clearNextCallSeq()
optional uint64 next_call_seq = 6; |
ClientProtos.ScanRequest.Builder |
clearNumberOfRows()
optional uint32 number_of_rows = 4; |
ClientProtos.ScanRequest.Builder |
clearOneof(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.OneofDescriptor oneof) |
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 org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
int |
getLimitOfRows()
if we have returned limit_of_rows rows to client, then close the scanner.
|
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()
if we have returned limit_of_rows rows to client, then close the scanner.
|
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 org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ClientProtos.ScanRequest.Builder |
mergeFrom(ClientProtos.ScanRequest other) |
ClientProtos.ScanRequest.Builder |
mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ClientProtos.ScanRequest.Builder |
mergeFrom(org.apache.hbase.thirdparty.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 |
mergeUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields) |
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 |
setField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ClientProtos.ScanRequest.Builder |
setLimitOfRows(int value)
if we have returned limit_of_rows rows to client, then close the scanner.
|
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 |
setRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
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; |
ClientProtos.ScanRequest.Builder |
setUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder clear()
clear in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builderclear in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderclear in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildergetDescriptorForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuildergetDescriptorForType in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilderpublic ClientProtos.ScanRequest build()
build in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builderbuild in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderpublic ClientProtos.ScanRequest buildPartial()
buildPartial in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderbuildPartial in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderpublic ClientProtos.ScanRequest.Builder clone()
clone in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builderclone in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderclone in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder setField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildersetField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder clearField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderclearField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder clearOneof(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderclearOneof in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder setRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildersetRepeatedField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder addRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderaddRepeatedField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message other)
mergeFrom in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildermergeFrom in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder mergeFrom(ClientProtos.ScanRequest other)
public final boolean isInitialized()
isInitialized in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilderisInitialized in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildermergeFrom in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.BuildermergeFrom in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>IOExceptionpublic boolean hasRegion()
optional .hbase.pb.RegionSpecifier region = 1;hasRegion in interface ClientProtos.ScanRequestOrBuilderpublic HBaseProtos.RegionSpecifier getRegion()
optional .hbase.pb.RegionSpecifier region = 1;getRegion in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic boolean hasScan()
optional .hbase.pb.Scan scan = 2;hasScan in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.Scan getScan()
optional .hbase.pb.Scan scan = 2;getScan in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic boolean hasScannerId()
optional uint64 scanner_id = 3;hasScannerId in interface ClientProtos.ScanRequestOrBuilderpublic long getScannerId()
optional uint64 scanner_id = 3;getScannerId in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic int getNumberOfRows()
optional uint32 number_of_rows = 4;getNumberOfRows in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic boolean getCloseScanner()
optional bool close_scanner = 5;getCloseScanner in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic long getNextCallSeq()
optional uint64 next_call_seq = 6;getNextCallSeq in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic boolean getClientHandlesPartials()
optional bool client_handles_partials = 7;getClientHandlesPartials in interface ClientProtos.ScanRequestOrBuilderpublic 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.ScanRequestOrBuilderpublic boolean getClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8;getClientHandlesHeartbeats in interface ClientProtos.ScanRequestOrBuilderpublic 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 hasTrackScanMetrics()
optional bool track_scan_metrics = 9;hasTrackScanMetrics in interface ClientProtos.ScanRequestOrBuilderpublic boolean getTrackScanMetrics()
optional bool track_scan_metrics = 9;getTrackScanMetrics in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setTrackScanMetrics(boolean value)
optional bool track_scan_metrics = 9;public ClientProtos.ScanRequest.Builder clearTrackScanMetrics()
optional bool track_scan_metrics = 9;public boolean hasRenew()
optional bool renew = 10 [default = false];hasRenew in interface ClientProtos.ScanRequestOrBuilderpublic boolean getRenew()
optional bool renew = 10 [default = false];getRenew in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setRenew(boolean value)
optional bool renew = 10 [default = false];public ClientProtos.ScanRequest.Builder clearRenew()
optional bool renew = 10 [default = false];public boolean hasLimitOfRows()
if we have returned limit_of_rows rows to client, then close the scanner.
optional uint32 limit_of_rows = 11 [default = 0];hasLimitOfRows in interface ClientProtos.ScanRequestOrBuilderpublic int getLimitOfRows()
if we have returned limit_of_rows rows to client, then close the scanner.
optional uint32 limit_of_rows = 11 [default = 0];getLimitOfRows in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setLimitOfRows(int value)
if we have returned limit_of_rows rows to client, then close the scanner.
optional uint32 limit_of_rows = 11 [default = 0];public ClientProtos.ScanRequest.Builder clearLimitOfRows()
if we have returned limit_of_rows rows to client, then close the scanner.
optional uint32 limit_of_rows = 11 [default = 0];public final ClientProtos.ScanRequest.Builder setUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildersetUnknownFields in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public final ClientProtos.ScanRequest.Builder mergeUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildermergeUnknownFields in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>Copyright © 2007–2019 Cloudera. All rights reserved.