org.hbase.async.generated

Class ClientPB.ScanRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.GeneratedMessageLite

org.hbase.async.generated.ClientPB.ScanRequest

All Implemented Interfaces:

com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Serializable, ClientPB.ScanRequestOrBuilder

Enclosing class:

ClientPB

public static final class ClientPB.ScanRequest
extends com.google.protobuf.GeneratedMessageLite
implements ClientPB.ScanRequestOrBuilder

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientPB.ScanRequest.Builder Protobuf type ScanRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>

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 com.google.protobuf.Parser<ClientPB.ScanRequest>	PARSER
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

Method Summary

Modifier and Type	Method and Description
boolean	getClientHandlesHeartbeats() optional bool client_handles_heartbeats = 8;
boolean	getClientHandlesPartials() optional bool client_handles_partials = 7;
boolean	getCloseScanner() optional bool close_scanner = 5;
static ClientPB.ScanRequest	getDefaultInstance()
ClientPB.ScanRequest	getDefaultInstanceForType()
long	getNextCallSeq() optional uint64 next_call_seq = 6;
int	getNumberOfRows() optional uint32 number_of_rows = 4;
com.google.protobuf.Parser<ClientPB.ScanRequest>	getParserForType()
HBasePB.RegionSpecifier	getRegion() optional .RegionSpecifier region = 1;
boolean	getRenew() optional bool renew = 10 [default = false];
ClientPB.Scan	getScan() optional .Scan scan = 2;
long	getScannerId() optional uint64 scanner_id = 3;
int	getSerializedSize()
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	hasNextCallSeq() optional uint64 next_call_seq = 6;
boolean	hasNumberOfRows() optional uint32 number_of_rows = 4;
boolean	hasRegion() optional .RegionSpecifier region = 1;
boolean	hasRenew() optional bool renew = 10 [default = false];
boolean	hasScan() optional .Scan scan = 2;
boolean	hasScannerId() optional uint64 scanner_id = 3;
boolean	hasTrackScanMetrics() optional bool track_scan_metrics = 9;
boolean	isInitialized()
static ClientPB.ScanRequest.Builder	newBuilder()
static ClientPB.ScanRequest.Builder	newBuilder(ClientPB.ScanRequest prototype)
ClientPB.ScanRequest.Builder	newBuilderForType()
static ClientPB.ScanRequest	parseDelimitedFrom(InputStream input)
static ClientPB.ScanRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientPB.ScanRequest	parseFrom(byte[] data)
static ClientPB.ScanRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientPB.ScanRequest	parseFrom(com.google.protobuf.ByteString data)
static ClientPB.ScanRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientPB.ScanRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ClientPB.ScanRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientPB.ScanRequest	parseFrom(InputStream input)
static ClientPB.ScanRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ClientPB.ScanRequest.Builder	toBuilder()
protected Object	writeReplace()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageLite

makeExtensionsImmutable, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

PARSER

public static com.google.protobuf.Parser<ClientPB.ScanRequest> 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

TRACK_SCAN_METRICS_FIELD_NUMBER

public static final int TRACK_SCAN_METRICS_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 ClientPB.ScanRequest getDefaultInstance()

getDefaultInstanceForType

public ClientPB.ScanRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

getParserForType

public com.google.protobuf.Parser<ClientPB.ScanRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageLite

hasRegion

public boolean hasRegion()

optional .RegionSpecifier region = 1;

Specified by:

hasRegion in interface ClientPB.ScanRequestOrBuilder

getRegion

public HBasePB.RegionSpecifier getRegion()

optional .RegionSpecifier region = 1;

Specified by:

getRegion in interface ClientPB.ScanRequestOrBuilder

hasScan

public boolean hasScan()

optional .Scan scan = 2;

Specified by:

hasScan in interface ClientPB.ScanRequestOrBuilder

getScan

public ClientPB.Scan getScan()

optional .Scan scan = 2;

Specified by:

getScan in interface ClientPB.ScanRequestOrBuilder

hasScannerId

public boolean hasScannerId()

optional uint64 scanner_id = 3;

Specified by:

hasScannerId in interface ClientPB.ScanRequestOrBuilder

getScannerId

public long getScannerId()

optional uint64 scanner_id = 3;

Specified by:

getScannerId in interface ClientPB.ScanRequestOrBuilder

hasNumberOfRows

public boolean hasNumberOfRows()

optional uint32 number_of_rows = 4;

Specified by:

hasNumberOfRows in interface ClientPB.ScanRequestOrBuilder

getNumberOfRows

public int getNumberOfRows()

optional uint32 number_of_rows = 4;

Specified by:

getNumberOfRows in interface ClientPB.ScanRequestOrBuilder

hasCloseScanner

public boolean hasCloseScanner()

optional bool close_scanner = 5;

Specified by:

hasCloseScanner in interface ClientPB.ScanRequestOrBuilder

getCloseScanner

public boolean getCloseScanner()

optional bool close_scanner = 5;

Specified by:

getCloseScanner in interface ClientPB.ScanRequestOrBuilder

hasNextCallSeq

public boolean hasNextCallSeq()

optional uint64 next_call_seq = 6;

Specified by:

hasNextCallSeq in interface ClientPB.ScanRequestOrBuilder

getNextCallSeq

public long getNextCallSeq()

optional uint64 next_call_seq = 6;

Specified by:

getNextCallSeq in interface ClientPB.ScanRequestOrBuilder

hasClientHandlesPartials

public boolean hasClientHandlesPartials()

optional bool client_handles_partials = 7;

Specified by:

hasClientHandlesPartials in interface ClientPB.ScanRequestOrBuilder

getClientHandlesPartials

public boolean getClientHandlesPartials()

optional bool client_handles_partials = 7;

Specified by:

getClientHandlesPartials in interface ClientPB.ScanRequestOrBuilder

hasClientHandlesHeartbeats

public boolean hasClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

Specified by:

hasClientHandlesHeartbeats in interface ClientPB.ScanRequestOrBuilder

getClientHandlesHeartbeats

public boolean getClientHandlesHeartbeats()

optional bool client_handles_heartbeats = 8;

Specified by:

getClientHandlesHeartbeats in interface ClientPB.ScanRequestOrBuilder

hasTrackScanMetrics

public boolean hasTrackScanMetrics()

optional bool track_scan_metrics = 9;

Specified by:

hasTrackScanMetrics in interface ClientPB.ScanRequestOrBuilder

getTrackScanMetrics

public boolean getTrackScanMetrics()

optional bool track_scan_metrics = 9;

Specified by:

getTrackScanMetrics in interface ClientPB.ScanRequestOrBuilder

hasRenew

public boolean hasRenew()

optional bool renew = 10 [default = false];

Specified by:

hasRenew in interface ClientPB.ScanRequestOrBuilder

getRenew

public boolean getRenew()

optional bool renew = 10 [default = false];

Specified by:

getRenew in interface ClientPB.ScanRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

writeTo

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

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Overrides:

writeReplace in class com.google.protobuf.GeneratedMessageLite

Throws:

ObjectStreamException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientPB.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 ClientPB.ScanRequest parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientPB.ScanRequest parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ClientPB.ScanRequest parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ClientPB.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilder

public static ClientPB.ScanRequest.Builder newBuilder()

newBuilderForType

public ClientPB.ScanRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

toBuilder

public ClientPB.ScanRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.MessageLite