org.apache.hadoop.hbase.protobuf.generated

Class ClientProtos.ScanRequest

java.lang.Object

com.google.protobuf.GeneratedMessage

org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest

All Implemented Interfaces:

ClientProtos.ScanRequestOrBuilder

Enclosing class:

ClientProtos

public static final class ClientProtos.ScanRequest
extends com.google.protobuf.GeneratedMessage
implements ClientProtos.ScanRequestOrBuilder

Protobuf type 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.
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientProtos.ScanRequest.Builder Protobuf type hbase.pb.ScanRequest

Field Summary

Fields

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

Method Summary

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)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARSER

public static <any> PARSER

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

See Also:

Constant Field Values

SCAN_FIELD_NUMBER

public static final int SCAN_FIELD_NUMBER

See Also:

Constant Field Values

SCANNER_ID_FIELD_NUMBER

public static final int SCANNER_ID_FIELD_NUMBER

See Also:

Constant Field Values

NUMBER_OF_ROWS_FIELD_NUMBER

public static final int NUMBER_OF_ROWS_FIELD_NUMBER

See Also:

Constant Field Values

CLOSE_SCANNER_FIELD_NUMBER

public static final int CLOSE_SCANNER_FIELD_NUMBER

See Also:

Constant Field Values

NEXT_CALL_SEQ_FIELD_NUMBER

public static final int NEXT_CALL_SEQ_FIELD_NUMBER

See Also:

Constant Field Values

CLIENT_HANDLES_PARTIALS_FIELD_NUMBER

public static final int CLIENT_HANDLES_PARTIALS_FIELD_NUMBER

See Also:

Constant Field Values

CLIENT_HANDLES_HEARTBEATS_FIELD_NUMBER

public static final int CLIENT_HANDLES_HEARTBEATS_FIELD_NUMBER

See Also:

Constant Field Values

RENEW_FIELD_NUMBER

public static final int RENEW_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static ClientProtos.ScanRequest getDefaultInstance()

getDefaultInstanceForType

public ClientProtos.ScanRequest getDefaultInstanceForType()

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

getParserForType

public <any> getParserForType()

hasRegion

public boolean hasRegion()

optional .hbase.pb.RegionSpecifier region = 1;

Specified by:

hasRegion in interface ClientProtos.ScanRequestOrBuilder

getRegion

public HBaseProtos.RegionSpecifier getRegion()

optional .hbase.pb.RegionSpecifier region = 1;

Specified by:

getRegion in interface ClientProtos.ScanRequestOrBuilder

getRegionOrBuilder

public HBaseProtos.RegionSpecifierOrBuilder getRegionOrBuilder()

optional .hbase.pb.RegionSpecifier region = 1;

Specified by:

getRegionOrBuilder in interface ClientProtos.ScanRequestOrBuilder

hasScan

public boolean hasScan()

optional .hbase.pb.Scan scan = 2;

Specified by:

hasScan in interface ClientProtos.ScanRequestOrBuilder

getScan

public ClientProtos.Scan getScan()

optional .hbase.pb.Scan scan = 2;

Specified by:

getScan in interface ClientProtos.ScanRequestOrBuilder

getScanOrBuilder

public ClientProtos.ScanOrBuilder getScanOrBuilder()

optional .hbase.pb.Scan scan = 2;

Specified by:

getScanOrBuilder in interface ClientProtos.ScanRequestOrBuilder

hasScannerId

public boolean hasScannerId()

optional uint64 scanner_id = 3;

Specified by:

hasScannerId in interface ClientProtos.ScanRequestOrBuilder

getScannerId

public long getScannerId()

optional uint64 scanner_id = 3;

Specified by:

getScannerId in interface ClientProtos.ScanRequestOrBuilder

hasNumberOfRows

public boolean hasNumberOfRows()

optional uint32 number_of_rows = 4;

Specified by:

hasNumberOfRows in interface ClientProtos.ScanRequestOrBuilder

getNumberOfRows

public int getNumberOfRows()

optional uint32 number_of_rows = 4;

Specified by:

getNumberOfRows in interface ClientProtos.ScanRequestOrBuilder

hasCloseScanner

public boolean hasCloseScanner()

optional bool close_scanner = 5;

Specified by:

hasCloseScanner in interface ClientProtos.ScanRequestOrBuilder

getCloseScanner

public boolean getCloseScanner()

optional bool close_scanner = 5;

Specified by:

getCloseScanner in interface ClientProtos.ScanRequestOrBuilder

hasNextCallSeq

public boolean hasNextCallSeq()

optional uint64 next_call_seq = 6;

Specified by:

hasNextCallSeq in interface ClientProtos.ScanRequestOrBuilder

getNextCallSeq

public long getNextCallSeq()

optional uint64 next_call_seq = 6;

Specified by:

getNextCallSeq in interface ClientProtos.ScanRequestOrBuilder

hasClientHandlesPartials

public boolean hasClientHandlesPartials()

optional bool client_handles_partials = 7;

Specified by:

hasClientHandlesPartials in interface ClientProtos.ScanRequestOrBuilder

getClientHandlesPartials

public boolean getClientHandlesPartials()

optional bool client_handles_partials = 7;

Specified by:

getClientHandlesPartials in interface ClientProtos.ScanRequestOrBuilder

hasClientHandlesHeartbeats

public boolean hasClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

Specified by:

hasClientHandlesHeartbeats in interface ClientProtos.ScanRequestOrBuilder

getClientHandlesHeartbeats

public boolean getClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

Specified by:

getClientHandlesHeartbeats in interface ClientProtos.ScanRequestOrBuilder

hasRenew

public boolean hasRenew()

optional bool renew = 10 [default = false];

Specified by:

hasRenew in interface ClientProtos.ScanRequestOrBuilder

getRenew

public boolean getRenew()

optional bool renew = 10 [default = false];

Specified by:

getRenew in interface ClientProtos.ScanRequestOrBuilder

isInitialized

public final boolean isInitialized()

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

writeReplace

protected java.lang.Object writeReplace()
                                 throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

parseFrom

public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientProtos.ScanRequest parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientProtos.ScanRequest parseFrom(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ClientProtos.ScanRequest parseDelimitedFrom(java.io.InputStream input)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ClientProtos.ScanRequest parseDelimitedFrom(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException

Throws:

java.io.IOException

newBuilder

public static ClientProtos.ScanRequest.Builder newBuilder()

newBuilderForType

public ClientProtos.ScanRequest.Builder newBuilderForType()

newBuilder

public static ClientProtos.ScanRequest.Builder newBuilder(ClientProtos.ScanRequest prototype)

toBuilder

public ClientProtos.ScanRequest.Builder toBuilder()

newBuilderForType

protected ClientProtos.ScanRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)