public static final class ClientProtos.ScanRequest extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3 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 | Class and Description |
|---|---|
static class |
ClientProtos.ScanRequest.Builder
A scan request.
|
org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.BuilderParent, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
CLIENT_HANDLES_HEARTBEATS_FIELD_NUMBER |
static int |
CLIENT_HANDLES_PARTIALS_FIELD_NUMBER |
static int |
CLOSE_SCANNER_FIELD_NUMBER |
static int |
LIMIT_OF_ROWS_FIELD_NUMBER |
static int |
NEXT_CALL_SEQ_FIELD_NUMBER |
static int |
NUMBER_OF_ROWS_FIELD_NUMBER |
static org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.ScanRequest> |
PARSER
Deprecated.
|
static int |
REGION_FIELD_NUMBER |
static int |
RENEW_FIELD_NUMBER |
static int |
SCAN_FIELD_NUMBER |
static int |
SCANNER_ID_FIELD_NUMBER |
static int |
TRACK_SCAN_METRICS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
boolean |
getClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8; |
boolean |
getClientHandlesPartials()
optional bool client_handles_partials = 7; |
boolean |
getCloseScanner()
optional bool close_scanner = 5; |
static ClientProtos.ScanRequest |
getDefaultInstance() |
ClientProtos.ScanRequest |
getDefaultInstanceForType() |
static org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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; |
org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.ScanRequest> |
getParserForType() |
HBaseProtos.RegionSpecifier |
getRegion()
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; |
long |
getScannerId()
optional uint64 scanner_id = 3; |
ClientProtos.ScanOrBuilder |
getScanOrBuilder()
optional .hbase.pb.Scan scan = 2; |
int |
getSerializedSize() |
boolean |
getTrackScanMetrics()
optional bool track_scan_metrics = 9; |
org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasClientHandlesHeartbeats()
optional bool client_handles_heartbeats = 8; |
boolean |
hasClientHandlesPartials()
optional bool client_handles_partials = 7; |
boolean |
hasCloseScanner()
optional bool close_scanner = 5; |
int |
hashCode() |
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() |
static ClientProtos.ScanRequest.Builder |
newBuilder() |
static ClientProtos.ScanRequest.Builder |
newBuilder(ClientProtos.ScanRequest prototype) |
ClientProtos.ScanRequest.Builder |
newBuilderForType() |
protected ClientProtos.ScanRequest.Builder |
newBuilderForType(org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static ClientProtos.ScanRequest |
parseDelimitedFrom(InputStream input) |
static ClientProtos.ScanRequest |
parseDelimitedFrom(InputStream input,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(byte[] data) |
static ClientProtos.ScanRequest |
parseFrom(byte[] data,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(ByteBuffer data) |
static ClientProtos.ScanRequest |
parseFrom(ByteBuffer data,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data) |
static ClientProtos.ScanRequest |
parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input) |
static ClientProtos.ScanRequest |
parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(InputStream input) |
static ClientProtos.ScanRequest |
parseFrom(InputStream input,
org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.ScanRequest> |
parser() |
ClientProtos.ScanRequest.Builder |
toBuilder() |
void |
writeTo(org.apache.hbase.thirdparty.com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int REGION_FIELD_NUMBER
public static final int SCAN_FIELD_NUMBER
public static final int SCANNER_ID_FIELD_NUMBER
public static final int NUMBER_OF_ROWS_FIELD_NUMBER
public static final int CLOSE_SCANNER_FIELD_NUMBER
public static final int NEXT_CALL_SEQ_FIELD_NUMBER
public static final int CLIENT_HANDLES_PARTIALS_FIELD_NUMBER
public static final int CLIENT_HANDLES_HEARTBEATS_FIELD_NUMBER
public static final int TRACK_SCAN_METRICS_FIELD_NUMBER
public static final int RENEW_FIELD_NUMBER
public static final int LIMIT_OF_ROWS_FIELD_NUMBER
@Deprecated public static final org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.ScanRequest> PARSER
public final org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuildergetUnknownFields in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3public 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.GeneratedMessageV3public 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 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.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 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 boolean hasCloseScanner()
optional bool close_scanner = 5;hasCloseScanner in interface ClientProtos.ScanRequestOrBuilderpublic boolean getCloseScanner()
optional bool close_scanner = 5;getCloseScanner in interface ClientProtos.ScanRequestOrBuilderpublic 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 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 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 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 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 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 final boolean isInitialized()
isInitialized in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilderisInitialized in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3public void writeTo(org.apache.hbase.thirdparty.com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLitewriteTo in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLitegetSerializedSize in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface org.apache.hbase.thirdparty.com.google.protobuf.Messageequals in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface org.apache.hbase.thirdparty.com.google.protobuf.MessagehashCode in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessagepublic static ClientProtos.ScanRequest parseFrom(ByteBuffer data) throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanRequest parseFrom(ByteBuffer data, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanRequest parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data) throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanRequest parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.ByteString data, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanRequest parseFrom(byte[] data) throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanRequest parseFrom(byte[] data, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException
org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ClientProtos.ScanRequest parseFrom(InputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClientProtos.ScanRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ClientProtos.ScanRequest parseDelimitedFrom(InputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClientProtos.ScanRequest parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ClientProtos.ScanRequest parseFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ClientProtos.ScanRequest.Builder newBuilderForType()
newBuilderForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessagenewBuilderForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLitepublic static ClientProtos.ScanRequest.Builder newBuilder()
public static ClientProtos.ScanRequest.Builder newBuilder(ClientProtos.ScanRequest prototype)
public ClientProtos.ScanRequest.Builder toBuilder()
toBuilder in interface org.apache.hbase.thirdparty.com.google.protobuf.MessagetoBuilder in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteprotected ClientProtos.ScanRequest.Builder newBuilderForType(org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3public static ClientProtos.ScanRequest getDefaultInstance()
public static org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.ScanRequest> parser()
public org.apache.hbase.thirdparty.com.google.protobuf.Parser<ClientProtos.ScanRequest> getParserForType()
getParserForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessagegetParserForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLitegetParserForType in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3public ClientProtos.ScanRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilderCopyright © 2007–2019 Cloudera. All rights reserved.