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

java.lang.Object
  extended by com.google.protobuf.AbstractMessageLite
      extended by com.google.protobuf.AbstractMessage
          extended by com.google.protobuf.GeneratedMessage
              extended by org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ClientProtos.ScanRequestOrBuilder
Enclosing class:
ClientProtos

public static final class ClientProtos.ScanRequest
extends com.google.protobuf.GeneratedMessage
implements ClientProtos.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
static class ClientProtos.ScanRequest.Builder
          Protobuf type ScanRequest
 
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>
 
Field Summary
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<ClientProtos.ScanRequest> PARSER
           
static int REGION_FIELD_NUMBER
           
static int SCAN_FIELD_NUMBER
           
static int SCANNER_ID_FIELD_NUMBER
           
 
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders
 
Method Summary
 boolean equals(Object obj)
           
 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;
 com.google.protobuf.Parser<ClientProtos.ScanRequest> getParserForType()
           
 HBaseProtos.RegionSpecifier getRegion()
          optional .RegionSpecifier region = 1;
 HBaseProtos.RegionSpecifierOrBuilder getRegionOrBuilder()
          optional .RegionSpecifier region = 1;
 ClientProtos.Scan getScan()
          optional .Scan scan = 2;
 long getScannerId()
          optional uint64 scanner_id = 3;
 ClientProtos.ScanOrBuilder getScanOrBuilder()
          optional .Scan scan = 2;
 int getSerializedSize()
           
 com.google.protobuf.UnknownFieldSet getUnknownFields()
           
 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 .RegionSpecifier region = 1;
 boolean hasScan()
          optional .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(InputStream input)
           
static ClientProtos.ScanRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
           
static ClientProtos.ScanRequest parseFrom(byte[] data)
           
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(InputStream input)
           
static ClientProtos.ScanRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
           
 ClientProtos.ScanRequest.Builder toBuilder()
           
protected  Object writeReplace()
           
 void writeTo(com.google.protobuf.CodedOutputStream output)
           
 
Methods inherited from class com.google.protobuf.GeneratedMessage
getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField
 
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
 
Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, hasField
 
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
 

Field Detail

PARSER

public static com.google.protobuf.Parser<ClientProtos.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
Method Detail

getDefaultInstance

public static ClientProtos.ScanRequest getDefaultInstance()

getDefaultInstanceForType

public ClientProtos.ScanRequest getDefaultInstanceForType()
Specified by:
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
Specified by:
getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()
Specified by:
getUnknownFields in interface com.google.protobuf.MessageOrBuilder
Overrides:
getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Specified by:
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getParserForType

public com.google.protobuf.Parser<ClientProtos.ScanRequest> getParserForType()
Specified by:
getParserForType in interface com.google.protobuf.Message
Specified by:
getParserForType in interface com.google.protobuf.MessageLite
Overrides:
getParserForType in class com.google.protobuf.GeneratedMessage

hasRegion

public boolean hasRegion()
optional .RegionSpecifier region = 1;

Specified by:
hasRegion in interface ClientProtos.ScanRequestOrBuilder

getRegion

public HBaseProtos.RegionSpecifier getRegion()
optional .RegionSpecifier region = 1;

Specified by:
getRegion in interface ClientProtos.ScanRequestOrBuilder

getRegionOrBuilder

public HBaseProtos.RegionSpecifierOrBuilder getRegionOrBuilder()
optional .RegionSpecifier region = 1;

Specified by:
getRegionOrBuilder in interface ClientProtos.ScanRequestOrBuilder

hasScan

public boolean hasScan()
optional .Scan scan = 2;

Specified by:
hasScan in interface ClientProtos.ScanRequestOrBuilder

getScan

public ClientProtos.Scan getScan()
optional .Scan scan = 2;

Specified by:
getScan in interface ClientProtos.ScanRequestOrBuilder

getScanOrBuilder

public ClientProtos.ScanOrBuilder getScanOrBuilder()
optional .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

isInitialized

public final boolean isInitialized()
Specified by:
isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
Overrides:
isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
Specified by:
writeTo in interface com.google.protobuf.MessageLite
Overrides:
writeTo in class com.google.protobuf.AbstractMessage
Throws:
IOException

getSerializedSize

public int getSerializedSize()
Specified by:
getSerializedSize in interface com.google.protobuf.MessageLite
Overrides:
getSerializedSize in class com.google.protobuf.AbstractMessage

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException
Overrides:
writeReplace in class com.google.protobuf.GeneratedMessage
Throws:
ObjectStreamException

equals

public boolean equals(Object obj)
Specified by:
equals in interface com.google.protobuf.Message
Overrides:
equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()
Specified by:
hashCode in interface com.google.protobuf.Message
Overrides:
hashCode in class com.google.protobuf.AbstractMessage

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)
                                          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(InputStream input)
                                          throws IOException
Throws:
IOException

parseFrom

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

parseDelimitedFrom

public static ClientProtos.ScanRequest parseDelimitedFrom(InputStream input)
                                                   throws IOException
Throws:
IOException

parseDelimitedFrom

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

parseFrom

public static ClientProtos.ScanRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException
Throws:
IOException

parseFrom

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

newBuilder

public static ClientProtos.ScanRequest.Builder newBuilder()

newBuilderForType

public ClientProtos.ScanRequest.Builder newBuilderForType()
Specified by:
newBuilderForType in interface com.google.protobuf.Message
Specified by:
newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

toBuilder

public ClientProtos.ScanRequest.Builder toBuilder()
Specified by:
toBuilder in interface com.google.protobuf.Message
Specified by:
toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ClientProtos.ScanRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
Specified by:
newBuilderForType in class com.google.protobuf.GeneratedMessage


Copyright © 2015 The Apache Software Foundation. All Rights Reserved.