public static final class ClientProtos.ScanRequest extends com.google.protobuf.GeneratedMessage 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 | Class and Description |
---|---|
static class |
ClientProtos.ScanRequest.Builder
Protobuf type
hbase.pb.ScanRequest |
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 |
NEXT_CALL_SEQ_FIELD_NUMBER |
static int |
NUMBER_OF_ROWS_FIELD_NUMBER |
static <any> |
PARSER |
static int |
REGION_FIELD_NUMBER |
static int |
RENEW_FIELD_NUMBER |
static int |
SCAN_FIELD_NUMBER |
static int |
SCANNER_ID_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.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 com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
long |
getNextCallSeq()
optional uint64 next_call_seq = 6; |
int |
getNumberOfRows()
optional uint32 number_of_rows = 4; |
<any> |
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() |
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 |
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() |
static ClientProtos.ScanRequest.Builder |
newBuilder() |
static ClientProtos.ScanRequest.Builder |
newBuilder(ClientProtos.ScanRequest prototype) |
ClientProtos.ScanRequest.Builder |
newBuilderForType() |
protected ClientProtos.ScanRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) |
static ClientProtos.ScanRequest |
parseDelimitedFrom(java.io.InputStream input) |
static ClientProtos.ScanRequest |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ClientProtos.ScanRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClientProtos.ScanRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanRequest |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ClientProtos.ScanRequest.Builder |
toBuilder() |
protected java.lang.Object |
writeReplace() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
public static <any> PARSER
public 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 RENEW_FIELD_NUMBER
public static ClientProtos.ScanRequest getDefaultInstance()
public ClientProtos.ScanRequest getDefaultInstanceForType()
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
public <any> getParserForType()
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 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.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 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 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 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 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 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 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 final boolean isInitialized()
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
java.io.IOException
public int getSerializedSize()
protected java.lang.Object writeReplace() throws java.io.ObjectStreamException
java.io.ObjectStreamException
public boolean equals(java.lang.Object obj)
public int hashCode()
public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientProtos.ScanRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientProtos.ScanRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static ClientProtos.ScanRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static ClientProtos.ScanRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static ClientProtos.ScanRequest.Builder newBuilder()
public ClientProtos.ScanRequest.Builder newBuilderForType()
public static ClientProtos.ScanRequest.Builder newBuilder(ClientProtos.ScanRequest prototype)
public ClientProtos.ScanRequest.Builder toBuilder()
protected ClientProtos.ScanRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)