org.apache.hadoop.hbase.protobuf.generated

Class ClientProtos.ScanResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ClientProtos.ScanResponseOrBuilder

Enclosing class:

ClientProtos

public static final class ClientProtos.ScanResponse
extends com.google.protobuf.GeneratedMessage
implements ClientProtos.ScanResponseOrBuilder

Protobuf type ScanResponse

 The scan response. If there are no more results, more_results will
 be false.  If it is not specified, it means there are more.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientProtos.ScanResponse.Builder Protobuf type ScanResponse

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

Fields

Modifier and Type	Field and Description
static int	CELLS_PER_RESULT_FIELD_NUMBER
static int	HEARTBEAT_MESSAGE_FIELD_NUMBER
static int	MORE_RESULTS_FIELD_NUMBER
static int	MORE_RESULTS_IN_REGION_FIELD_NUMBER
static com.google.protobuf.Parser<ClientProtos.ScanResponse>	PARSER
static int	PARTIAL_FLAG_PER_RESULT_FIELD_NUMBER
static int	RESULTS_FIELD_NUMBER
static int	SCANNER_ID_FIELD_NUMBER
static int	STALE_FIELD_NUMBER
static int	TTL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getCellsPerResult(int index) repeated uint32 cells_per_result = 1;
int	getCellsPerResultCount() repeated uint32 cells_per_result = 1;
List<Integer>	getCellsPerResultList() repeated uint32 cells_per_result = 1;
static ClientProtos.ScanResponse	getDefaultInstance()
ClientProtos.ScanResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getHeartbeatMessage() optional bool heartbeat_message = 9;
boolean	getMoreResults() optional bool more_results = 3;
boolean	getMoreResultsInRegion() optional bool more_results_in_region = 8;
com.google.protobuf.Parser<ClientProtos.ScanResponse>	getParserForType()
boolean	getPartialFlagPerResult(int index) repeated bool partial_flag_per_result = 7;
int	getPartialFlagPerResultCount() repeated bool partial_flag_per_result = 7;
List<Boolean>	getPartialFlagPerResultList() repeated bool partial_flag_per_result = 7;
ClientProtos.Result	getResults(int index) repeated .Result results = 5;
int	getResultsCount() repeated .Result results = 5;
List<ClientProtos.Result>	getResultsList() repeated .Result results = 5;
ClientProtos.ResultOrBuilder	getResultsOrBuilder(int index) repeated .Result results = 5;
List<? extends ClientProtos.ResultOrBuilder>	getResultsOrBuilderList() repeated .Result results = 5;
long	getScannerId() optional uint64 scanner_id = 2;
int	getSerializedSize()
boolean	getStale() optional bool stale = 6;
int	getTtl() optional uint32 ttl = 4;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasHeartbeatMessage() optional bool heartbeat_message = 9;
boolean	hasMoreResults() optional bool more_results = 3;
boolean	hasMoreResultsInRegion() optional bool more_results_in_region = 8;
boolean	hasScannerId() optional uint64 scanner_id = 2;
boolean	hasStale() optional bool stale = 6;
boolean	hasTtl() optional uint32 ttl = 4;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ClientProtos.ScanResponse.Builder	newBuilder()
static ClientProtos.ScanResponse.Builder	newBuilder(ClientProtos.ScanResponse prototype)
ClientProtos.ScanResponse.Builder	newBuilderForType()
protected ClientProtos.ScanResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static ClientProtos.ScanResponse	parseDelimitedFrom(InputStream input)
static ClientProtos.ScanResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientProtos.ScanResponse	parseFrom(byte[] data)
static ClientProtos.ScanResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientProtos.ScanResponse	parseFrom(com.google.protobuf.ByteString data)
static ClientProtos.ScanResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientProtos.ScanResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static ClientProtos.ScanResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClientProtos.ScanResponse	parseFrom(InputStream input)
static ClientProtos.ScanResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ClientProtos.ScanResponse.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.ScanResponse> PARSER

CELLS_PER_RESULT_FIELD_NUMBER

public static final int CELLS_PER_RESULT_FIELD_NUMBER

See Also:

Constant Field Values

SCANNER_ID_FIELD_NUMBER

public static final int SCANNER_ID_FIELD_NUMBER

See Also:

Constant Field Values

MORE_RESULTS_FIELD_NUMBER

public static final int MORE_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER

See Also:

Constant Field Values

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

STALE_FIELD_NUMBER

public static final int STALE_FIELD_NUMBER

See Also:

Constant Field Values

PARTIAL_FLAG_PER_RESULT_FIELD_NUMBER

public static final int PARTIAL_FLAG_PER_RESULT_FIELD_NUMBER

See Also:

Constant Field Values

MORE_RESULTS_IN_REGION_FIELD_NUMBER

public static final int MORE_RESULTS_IN_REGION_FIELD_NUMBER

See Also:

Constant Field Values

HEARTBEAT_MESSAGE_FIELD_NUMBER

public static final int HEARTBEAT_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static ClientProtos.ScanResponse getDefaultInstance()

getDefaultInstanceForType

public ClientProtos.ScanResponse 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.ScanResponse> 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

getCellsPerResultList

public List<Integer> getCellsPerResultList()

repeated uint32 cells_per_result = 1;

 This field is filled in if we are doing cellblocks.  A cellblock is made up
 of all Cells serialized out as one cellblock BUT responses from a server
 have their Cells grouped by Result.  So we can reconstitute the
 Results on the client-side, this field is a list of counts of Cells
 in each Result that makes up the response.  For example, if this field
 has 3, 3, 3 in it, then we know that on the client, we are to make
 three Results each of three Cells each.
 

Specified by:

getCellsPerResultList in interface ClientProtos.ScanResponseOrBuilder

getCellsPerResultCount

public int getCellsPerResultCount()

repeated uint32 cells_per_result = 1;

 This field is filled in if we are doing cellblocks.  A cellblock is made up
 of all Cells serialized out as one cellblock BUT responses from a server
 have their Cells grouped by Result.  So we can reconstitute the
 Results on the client-side, this field is a list of counts of Cells
 in each Result that makes up the response.  For example, if this field
 has 3, 3, 3 in it, then we know that on the client, we are to make
 three Results each of three Cells each.
 

Specified by:

getCellsPerResultCount in interface ClientProtos.ScanResponseOrBuilder

getCellsPerResult

public int getCellsPerResult(int index)

repeated uint32 cells_per_result = 1;

 This field is filled in if we are doing cellblocks.  A cellblock is made up
 of all Cells serialized out as one cellblock BUT responses from a server
 have their Cells grouped by Result.  So we can reconstitute the
 Results on the client-side, this field is a list of counts of Cells
 in each Result that makes up the response.  For example, if this field
 has 3, 3, 3 in it, then we know that on the client, we are to make
 three Results each of three Cells each.
 

Specified by:

getCellsPerResult in interface ClientProtos.ScanResponseOrBuilder

hasScannerId

public boolean hasScannerId()

optional uint64 scanner_id = 2;

Specified by:

hasScannerId in interface ClientProtos.ScanResponseOrBuilder

getScannerId

public long getScannerId()

optional uint64 scanner_id = 2;

Specified by:

getScannerId in interface ClientProtos.ScanResponseOrBuilder

hasMoreResults

public boolean hasMoreResults()

optional bool more_results = 3;

Specified by:

hasMoreResults in interface ClientProtos.ScanResponseOrBuilder

getMoreResults

public boolean getMoreResults()

optional bool more_results = 3;

Specified by:

getMoreResults in interface ClientProtos.ScanResponseOrBuilder

hasTtl

public boolean hasTtl()

optional uint32 ttl = 4;

Specified by:

hasTtl in interface ClientProtos.ScanResponseOrBuilder

getTtl

public int getTtl()

optional uint32 ttl = 4;

Specified by:

getTtl in interface ClientProtos.ScanResponseOrBuilder

getResultsList

public List<ClientProtos.Result> getResultsList()

repeated .Result results = 5;

 If cells are not carried in an accompanying cellblock, then they are pb'd here.
 This field is mutually exclusive with cells_per_result (since the Cells will
 be inside the pb'd Result)
 

Specified by:

getResultsList in interface ClientProtos.ScanResponseOrBuilder

getResultsOrBuilderList

public List<? extends ClientProtos.ResultOrBuilder> getResultsOrBuilderList()

repeated .Result results = 5;

 If cells are not carried in an accompanying cellblock, then they are pb'd here.
 This field is mutually exclusive with cells_per_result (since the Cells will
 be inside the pb'd Result)
 

Specified by:

getResultsOrBuilderList in interface ClientProtos.ScanResponseOrBuilder

getResultsCount

public int getResultsCount()

repeated .Result results = 5;

 If cells are not carried in an accompanying cellblock, then they are pb'd here.
 This field is mutually exclusive with cells_per_result (since the Cells will
 be inside the pb'd Result)
 

Specified by:

getResultsCount in interface ClientProtos.ScanResponseOrBuilder

getResults

public ClientProtos.Result getResults(int index)

repeated .Result results = 5;

 If cells are not carried in an accompanying cellblock, then they are pb'd here.
 This field is mutually exclusive with cells_per_result (since the Cells will
 be inside the pb'd Result)
 

Specified by:

getResults in interface ClientProtos.ScanResponseOrBuilder

getResultsOrBuilder

public ClientProtos.ResultOrBuilder getResultsOrBuilder(int index)

repeated .Result results = 5;

 If cells are not carried in an accompanying cellblock, then they are pb'd here.
 This field is mutually exclusive with cells_per_result (since the Cells will
 be inside the pb'd Result)
 

Specified by:

getResultsOrBuilder in interface ClientProtos.ScanResponseOrBuilder

hasStale

public boolean hasStale()

optional bool stale = 6;

Specified by:

hasStale in interface ClientProtos.ScanResponseOrBuilder

getStale

public boolean getStale()

optional bool stale = 6;

Specified by:

getStale in interface ClientProtos.ScanResponseOrBuilder

getPartialFlagPerResultList

public List<Boolean> getPartialFlagPerResultList()

repeated bool partial_flag_per_result = 7;

 This field is filled in if we are doing cellblocks. In the event that a row
 could not fit all of its cells into a single RPC chunk, the results will be
 returned as partials, and reconstructed into a complete result on the client
 side. This field is a list of flags indicating whether or not the result
 that the cells belong to is a partial result. For example, if this field
 has false, false, true in it, then we know that on the client side, we need to
 make another RPC request since the last result was only a partial.
 

Specified by:

getPartialFlagPerResultList in interface ClientProtos.ScanResponseOrBuilder

getPartialFlagPerResultCount

public int getPartialFlagPerResultCount()

repeated bool partial_flag_per_result = 7;

 This field is filled in if we are doing cellblocks. In the event that a row
 could not fit all of its cells into a single RPC chunk, the results will be
 returned as partials, and reconstructed into a complete result on the client
 side. This field is a list of flags indicating whether or not the result
 that the cells belong to is a partial result. For example, if this field
 has false, false, true in it, then we know that on the client side, we need to
 make another RPC request since the last result was only a partial.
 

Specified by:

getPartialFlagPerResultCount in interface ClientProtos.ScanResponseOrBuilder

getPartialFlagPerResult

public boolean getPartialFlagPerResult(int index)

repeated bool partial_flag_per_result = 7;

 This field is filled in if we are doing cellblocks. In the event that a row
 could not fit all of its cells into a single RPC chunk, the results will be
 returned as partials, and reconstructed into a complete result on the client
 side. This field is a list of flags indicating whether or not the result
 that the cells belong to is a partial result. For example, if this field
 has false, false, true in it, then we know that on the client side, we need to
 make another RPC request since the last result was only a partial.
 

Specified by:

getPartialFlagPerResult in interface ClientProtos.ScanResponseOrBuilder

hasMoreResultsInRegion

public boolean hasMoreResultsInRegion()

optional bool more_results_in_region = 8;

 A server may choose to limit the number of results returned to the client for
 reasons such as the size in bytes or quantity of results accumulated. This field
 will true when more results exist in the current region.
 

Specified by:

hasMoreResultsInRegion in interface ClientProtos.ScanResponseOrBuilder

getMoreResultsInRegion

public boolean getMoreResultsInRegion()

optional bool more_results_in_region = 8;

 A server may choose to limit the number of results returned to the client for
 reasons such as the size in bytes or quantity of results accumulated. This field
 will true when more results exist in the current region.
 

Specified by:

getMoreResultsInRegion in interface ClientProtos.ScanResponseOrBuilder

hasHeartbeatMessage

public boolean hasHeartbeatMessage()

optional bool heartbeat_message = 9;

 This field is filled in if the server is sending back a heartbeat message.
 Heartbeat messages are sent back to the client to prevent the scanner from
 timing out. Seeing a heartbeat message communicates to the Client that the
 server would have continued to scan had the time limit not been reached.
 

Specified by:

hasHeartbeatMessage in interface ClientProtos.ScanResponseOrBuilder

getHeartbeatMessage

public boolean getHeartbeatMessage()

optional bool heartbeat_message = 9;

 This field is filled in if the server is sending back a heartbeat message.
 Heartbeat messages are sent back to the client to prevent the scanner from
 timing out. Seeing a heartbeat message communicates to the Client that the
 server would have continued to scan had the time limit not been reached.
 

Specified by:

getHeartbeatMessage in interface ClientProtos.ScanResponseOrBuilder

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.ScanResponse parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClientProtos.ScanResponse parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ClientProtos.ScanResponse parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ClientProtos.ScanResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilder

public static ClientProtos.ScanResponse.Builder newBuilder()

newBuilderForType

public ClientProtos.ScanResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

toBuilder

public ClientProtos.ScanResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage