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| 限定符和类型 | 方法和说明 |
|---|---|
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, newUninitializedMessageExceptionpublic static final org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable 在类中 org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder clear()
clear 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.Builderclear 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderclear 在类中 org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildergetDescriptorForType 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuildergetDescriptorForType 在类中 org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest getDefaultInstanceForType()
getDefaultInstanceForType 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilderpublic ClientProtos.ScanRequest build()
build 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.Builderbuild 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderpublic ClientProtos.ScanRequest buildPartial()
buildPartial 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderbuildPartial 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderpublic ClientProtos.ScanRequest.Builder clone()
clone 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.Builderclone 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builderclone 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildersetField 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderclearField 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderclearOneof 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildersetRepeatedField 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuilderaddRepeatedField 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildermergeFrom 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilderisInitialized 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildermergeFrom 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.BuildermergeFrom 在类中 org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>IOExceptionpublic boolean hasRegion()
optional .hbase.pb.RegionSpecifier region = 1;hasRegion 在接口中 ClientProtos.ScanRequestOrBuilderpublic HBaseProtos.RegionSpecifier getRegion()
optional .hbase.pb.RegionSpecifier region = 1;getRegion 在接口中 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;public boolean hasScan()
optional .hbase.pb.Scan scan = 2;hasScan 在接口中 ClientProtos.ScanRequestOrBuilderpublic ClientProtos.Scan getScan()
optional .hbase.pb.Scan scan = 2;getScan 在接口中 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;public boolean hasScannerId()
optional uint64 scanner_id = 3;public long getScannerId()
optional uint64 scanner_id = 3;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;public int getNumberOfRows()
optional uint32 number_of_rows = 4;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;public boolean getCloseScanner()
optional bool close_scanner = 5;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;public long getNextCallSeq()
optional uint64 next_call_seq = 6;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;public boolean getClientHandlesPartials()
optional bool client_handles_partials = 7;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;public boolean getClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8;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 hasTrackScanMetrics()
optional bool track_scan_metrics = 9;public boolean getTrackScanMetrics()
optional bool track_scan_metrics = 9;public 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 在接口中 ClientProtos.ScanRequestOrBuilderpublic boolean getRenew()
optional bool renew = 10 [default = false];getRenew 在接口中 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];public int getLimitOfRows()
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 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildersetUnknownFields 在类中 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 在接口中 org.apache.hbase.thirdparty.com.google.protobuf.Message.BuildermergeUnknownFields 在类中 org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanRequest.Builder>Copyright © 2007–2019. All rights reserved.