org.apache.hadoop.hbase.shaded.protobuf.generated

Class ClientProtos.ScanResponse.Builder

java.lang.Object

org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessageLite.Builder

org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder<BuilderType>

org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

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

All Implemented Interfaces:

Cloneable, ClientProtos.ScanResponseOrBuilder, org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder, org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder, org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder, org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

Enclosing class:

ClientProtos.ScanResponse

public static final class ClientProtos.ScanResponse.Builder
extends org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>
implements ClientProtos.ScanResponseOrBuilder

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

Protobuf type hbase.pb.ScanResponse

Method Summary

Modifier and Type	Method and Description
ClientProtos.ScanResponse.Builder	addAllCellsPerResult(Iterable<? extends Integer> values) This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	addAllPartialFlagPerResult(Iterable<? extends Boolean> values) This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	addAllResults(Iterable<? extends ClientProtos.Result> values) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	addCellsPerResult(int value) This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	addPartialFlagPerResult(boolean value) This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	addRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ClientProtos.ScanResponse.Builder	addResults(ClientProtos.Result.Builder builderForValue) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	addResults(ClientProtos.Result value) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	addResults(int index, ClientProtos.Result.Builder builderForValue) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	addResults(int index, ClientProtos.Result value) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.Result.Builder	addResultsBuilder() If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.Result.Builder	addResultsBuilder(int index) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse	build()
ClientProtos.ScanResponse	buildPartial()
ClientProtos.ScanResponse.Builder	clear()
ClientProtos.ScanResponse.Builder	clearCellsPerResult() This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	clearCursor() If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.ScanResponse.Builder	clearField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field)
ClientProtos.ScanResponse.Builder	clearHeartbeatMessage() This field is filled in if the server is sending back a heartbeat message.
ClientProtos.ScanResponse.Builder	clearMoreResults() optional bool more_results = 3;
ClientProtos.ScanResponse.Builder	clearMoreResultsInRegion() 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.
ClientProtos.ScanResponse.Builder	clearMvccReadPoint() The mvcc read point which is used to open the scanner at server side.
ClientProtos.ScanResponse.Builder	clearOneof(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.OneofDescriptor oneof)
ClientProtos.ScanResponse.Builder	clearPartialFlagPerResult() This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	clearResults() If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	clearScanMetrics() This field is filled in if the client has requested that scan metrics be tracked.
ClientProtos.ScanResponse.Builder	clearScannerId() optional uint64 scanner_id = 2;
ClientProtos.ScanResponse.Builder	clearStale() optional bool stale = 6;
ClientProtos.ScanResponse.Builder	clearTtl() optional uint32 ttl = 4;
ClientProtos.ScanResponse.Builder	clone()
int	getCellsPerResult(int index) This field is filled in if we are doing cellblocks.
int	getCellsPerResultCount() This field is filled in if we are doing cellblocks.
List<Integer>	getCellsPerResultList() This field is filled in if we are doing cellblocks.
ClientProtos.Cursor	getCursor() If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.Cursor.Builder	getCursorBuilder() If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.CursorOrBuilder	getCursorOrBuilder() If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.ScanResponse	getDefaultInstanceForType()
static org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor	getDescriptor()
org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getHeartbeatMessage() This field is filled in if the server is sending back a heartbeat message.
boolean	getMoreResults() optional bool more_results = 3;
boolean	getMoreResultsInRegion() 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.
long	getMvccReadPoint() The mvcc read point which is used to open the scanner at server side.
boolean	getPartialFlagPerResult(int index) This field is filled in if we are doing cellblocks.
int	getPartialFlagPerResultCount() This field is filled in if we are doing cellblocks.
List<Boolean>	getPartialFlagPerResultList() This field is filled in if we are doing cellblocks.
ClientProtos.Result	getResults(int index) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.Result.Builder	getResultsBuilder(int index) If cells are not carried in an accompanying cellblock, then they are pb'd here.
List<ClientProtos.Result.Builder>	getResultsBuilderList() If cells are not carried in an accompanying cellblock, then they are pb'd here.
int	getResultsCount() If cells are not carried in an accompanying cellblock, then they are pb'd here.
List<ClientProtos.Result>	getResultsList() If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ResultOrBuilder	getResultsOrBuilder(int index) If cells are not carried in an accompanying cellblock, then they are pb'd here.
List<? extends ClientProtos.ResultOrBuilder>	getResultsOrBuilderList() If cells are not carried in an accompanying cellblock, then they are pb'd here.
MapReduceProtos.ScanMetrics	getScanMetrics() This field is filled in if the client has requested that scan metrics be tracked.
MapReduceProtos.ScanMetrics.Builder	getScanMetricsBuilder() This field is filled in if the client has requested that scan metrics be tracked.
MapReduceProtos.ScanMetricsOrBuilder	getScanMetricsOrBuilder() This field is filled in if the client has requested that scan metrics be tracked.
long	getScannerId() optional uint64 scanner_id = 2;
boolean	getStale() optional bool stale = 6;
int	getTtl() optional uint32 ttl = 4;
boolean	hasCursor() If the Scan need cursor, return the row key we are scanning in heartbeat message.
boolean	hasHeartbeatMessage() This field is filled in if the server is sending back a heartbeat message.
boolean	hasMoreResults() optional bool more_results = 3;
boolean	hasMoreResultsInRegion() 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.
boolean	hasMvccReadPoint() The mvcc read point which is used to open the scanner at server side.
boolean	hasScanMetrics() This field is filled in if the client has requested that scan metrics be tracked.
boolean	hasScannerId() optional uint64 scanner_id = 2;
boolean	hasStale() optional bool stale = 6;
boolean	hasTtl() optional uint32 ttl = 4;
protected org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ClientProtos.ScanResponse.Builder	mergeCursor(ClientProtos.Cursor value) If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.ScanResponse.Builder	mergeFrom(ClientProtos.ScanResponse other)
ClientProtos.ScanResponse.Builder	mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input, org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ClientProtos.ScanResponse.Builder	mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message other)
ClientProtos.ScanResponse.Builder	mergeScanMetrics(MapReduceProtos.ScanMetrics value) This field is filled in if the client has requested that scan metrics be tracked.
ClientProtos.ScanResponse.Builder	mergeUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields)
ClientProtos.ScanResponse.Builder	removeResults(int index) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	setCellsPerResult(int index, int value) This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	setCursor(ClientProtos.Cursor.Builder builderForValue) If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.ScanResponse.Builder	setCursor(ClientProtos.Cursor value) If the Scan need cursor, return the row key we are scanning in heartbeat message.
ClientProtos.ScanResponse.Builder	setField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ClientProtos.ScanResponse.Builder	setHeartbeatMessage(boolean value) This field is filled in if the server is sending back a heartbeat message.
ClientProtos.ScanResponse.Builder	setMoreResults(boolean value) optional bool more_results = 3;
ClientProtos.ScanResponse.Builder	setMoreResultsInRegion(boolean value) 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.
ClientProtos.ScanResponse.Builder	setMvccReadPoint(long value) The mvcc read point which is used to open the scanner at server side.
ClientProtos.ScanResponse.Builder	setPartialFlagPerResult(int index, boolean value) This field is filled in if we are doing cellblocks.
ClientProtos.ScanResponse.Builder	setRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ClientProtos.ScanResponse.Builder	setResults(int index, ClientProtos.Result.Builder builderForValue) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	setResults(int index, ClientProtos.Result value) If cells are not carried in an accompanying cellblock, then they are pb'd here.
ClientProtos.ScanResponse.Builder	setScanMetrics(MapReduceProtos.ScanMetrics.Builder builderForValue) This field is filled in if the client has requested that scan metrics be tracked.
ClientProtos.ScanResponse.Builder	setScanMetrics(MapReduceProtos.ScanMetrics value) This field is filled in if the client has requested that scan metrics be tracked.
ClientProtos.ScanResponse.Builder	setScannerId(long value) optional uint64 scanner_id = 2;
ClientProtos.ScanResponse.Builder	setStale(boolean value) optional bool stale = 6;
ClientProtos.ScanResponse.Builder	setTtl(int value) optional uint32 ttl = 4;
ClientProtos.ScanResponse.Builder	setUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

clear

public ClientProtos.ScanResponse.Builder clear()

Specified by:

clear in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Specified by:

clear in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder

Overrides:

clear in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

getDescriptorForType

public org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

getDefaultInstanceForType

public ClientProtos.ScanResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

build

public ClientProtos.ScanResponse build()

Specified by:

build in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Specified by:

build in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder

buildPartial

public ClientProtos.ScanResponse buildPartial()

Specified by:

buildPartial in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder

clone

public ClientProtos.ScanResponse.Builder clone()

Specified by:

clone in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Specified by:

clone in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder

Overrides:

clone in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

setField

public ClientProtos.ScanResponse.Builder setField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

setField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

setField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

clearField

public ClientProtos.ScanResponse.Builder clearField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

clearField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

clearOneof

public ClientProtos.ScanResponse.Builder clearOneof(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

clearOneof in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

setRepeatedField

public ClientProtos.ScanResponse.Builder setRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)

Specified by:

setRepeatedField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

addRepeatedField

public ClientProtos.ScanResponse.Builder addRepeatedField(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)

Specified by:

addRepeatedField in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

mergeFrom

public ClientProtos.ScanResponse.Builder mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message other)

Specified by:

mergeFrom in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanResponse.Builder>

mergeFrom

public ClientProtos.ScanResponse.Builder mergeFrom(ClientProtos.ScanResponse other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

mergeFrom

public ClientProtos.ScanResponse.Builder mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream input,
                                                   org.apache.hbase.thirdparty.com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:

mergeFrom in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface org.apache.hbase.thirdparty.com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class org.apache.hbase.thirdparty.com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanResponse.Builder>

Throws:

IOException

getCellsPerResultList

public List<Integer> getCellsPerResultList()

 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.
 

repeated uint32 cells_per_result = 1;

Specified by:

getCellsPerResultList in interface ClientProtos.ScanResponseOrBuilder

getCellsPerResultCount

public int getCellsPerResultCount()

 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.
 

repeated uint32 cells_per_result = 1;

Specified by:

getCellsPerResultCount in interface ClientProtos.ScanResponseOrBuilder

getCellsPerResult

public int getCellsPerResult(int index)

 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.
 

repeated uint32 cells_per_result = 1;

Specified by:

getCellsPerResult in interface ClientProtos.ScanResponseOrBuilder

setCellsPerResult

public ClientProtos.ScanResponse.Builder setCellsPerResult(int index,
                                                           int value)

 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.
 

repeated uint32 cells_per_result = 1;

addCellsPerResult

public ClientProtos.ScanResponse.Builder addCellsPerResult(int value)

 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.
 

repeated uint32 cells_per_result = 1;

addAllCellsPerResult

public ClientProtos.ScanResponse.Builder addAllCellsPerResult(Iterable<? extends Integer> values)

 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.
 

repeated uint32 cells_per_result = 1;

clearCellsPerResult

public ClientProtos.ScanResponse.Builder clearCellsPerResult()

 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.
 

repeated uint32 cells_per_result = 1;

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

setScannerId

public ClientProtos.ScanResponse.Builder setScannerId(long value)

optional uint64 scanner_id = 2;

clearScannerId

public ClientProtos.ScanResponse.Builder clearScannerId()

optional uint64 scanner_id = 2;

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

setMoreResults

public ClientProtos.ScanResponse.Builder setMoreResults(boolean value)

optional bool more_results = 3;

clearMoreResults

public ClientProtos.ScanResponse.Builder clearMoreResults()

optional bool more_results = 3;

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

setTtl

public ClientProtos.ScanResponse.Builder setTtl(int value)

optional uint32 ttl = 4;

clearTtl

public ClientProtos.ScanResponse.Builder clearTtl()

optional uint32 ttl = 4;

getResultsList

public List<ClientProtos.Result> getResultsList()

 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)
 

repeated .hbase.pb.Result results = 5;

Specified by:

getResultsList in interface ClientProtos.ScanResponseOrBuilder

getResultsCount

public int getResultsCount()

 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)
 

repeated .hbase.pb.Result results = 5;

Specified by:

getResultsCount in interface ClientProtos.ScanResponseOrBuilder

getResults

public ClientProtos.Result getResults(int index)

 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)
 

repeated .hbase.pb.Result results = 5;

Specified by:

getResults in interface ClientProtos.ScanResponseOrBuilder

setResults

public ClientProtos.ScanResponse.Builder setResults(int index,
                                                    ClientProtos.Result value)

 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)
 

repeated .hbase.pb.Result results = 5;

setResults

public ClientProtos.ScanResponse.Builder setResults(int index,
                                                    ClientProtos.Result.Builder builderForValue)

 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)
 

repeated .hbase.pb.Result results = 5;

addResults

public ClientProtos.ScanResponse.Builder addResults(ClientProtos.Result value)

 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)
 

repeated .hbase.pb.Result results = 5;

addResults

public ClientProtos.ScanResponse.Builder addResults(int index,
                                                    ClientProtos.Result value)

 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)
 

repeated .hbase.pb.Result results = 5;

addResults

public ClientProtos.ScanResponse.Builder addResults(ClientProtos.Result.Builder builderForValue)

 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)
 

repeated .hbase.pb.Result results = 5;

addResults

public ClientProtos.ScanResponse.Builder addResults(int index,
                                                    ClientProtos.Result.Builder builderForValue)

 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)
 

repeated .hbase.pb.Result results = 5;

addAllResults

public ClientProtos.ScanResponse.Builder addAllResults(Iterable<? extends ClientProtos.Result> values)

 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)
 

repeated .hbase.pb.Result results = 5;

clearResults

public ClientProtos.ScanResponse.Builder clearResults()

 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)
 

repeated .hbase.pb.Result results = 5;

removeResults

public ClientProtos.ScanResponse.Builder removeResults(int index)

 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)
 

repeated .hbase.pb.Result results = 5;

getResultsBuilder

public ClientProtos.Result.Builder getResultsBuilder(int index)

 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)
 

repeated .hbase.pb.Result results = 5;

getResultsOrBuilder

public ClientProtos.ResultOrBuilder getResultsOrBuilder(int index)

 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)
 

repeated .hbase.pb.Result results = 5;

Specified by:

getResultsOrBuilder in interface ClientProtos.ScanResponseOrBuilder

getResultsOrBuilderList

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

 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)
 

repeated .hbase.pb.Result results = 5;

Specified by:

getResultsOrBuilderList in interface ClientProtos.ScanResponseOrBuilder

addResultsBuilder

public ClientProtos.Result.Builder addResultsBuilder()

 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)
 

repeated .hbase.pb.Result results = 5;

addResultsBuilder

public ClientProtos.Result.Builder addResultsBuilder(int index)

 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)
 

repeated .hbase.pb.Result results = 5;

getResultsBuilderList

public List<ClientProtos.Result.Builder> getResultsBuilderList()

 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)
 

repeated .hbase.pb.Result results = 5;

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

setStale

public ClientProtos.ScanResponse.Builder setStale(boolean value)

optional bool stale = 6;

clearStale

public ClientProtos.ScanResponse.Builder clearStale()

optional bool stale = 6;

getPartialFlagPerResultList

public List<Boolean> getPartialFlagPerResultList()

 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.
 

repeated bool partial_flag_per_result = 7;

Specified by:

getPartialFlagPerResultList in interface ClientProtos.ScanResponseOrBuilder

getPartialFlagPerResultCount

public int getPartialFlagPerResultCount()

 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.
 

repeated bool partial_flag_per_result = 7;

Specified by:

getPartialFlagPerResultCount in interface ClientProtos.ScanResponseOrBuilder

getPartialFlagPerResult

public boolean getPartialFlagPerResult(int index)

 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.
 

repeated bool partial_flag_per_result = 7;

Specified by:

getPartialFlagPerResult in interface ClientProtos.ScanResponseOrBuilder

setPartialFlagPerResult

public ClientProtos.ScanResponse.Builder setPartialFlagPerResult(int index,
                                                                 boolean value)

 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.
 

repeated bool partial_flag_per_result = 7;

addPartialFlagPerResult

public ClientProtos.ScanResponse.Builder addPartialFlagPerResult(boolean value)

 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.
 

repeated bool partial_flag_per_result = 7;

addAllPartialFlagPerResult

public ClientProtos.ScanResponse.Builder addAllPartialFlagPerResult(Iterable<? extends Boolean> values)

 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.
 

repeated bool partial_flag_per_result = 7;

clearPartialFlagPerResult

public ClientProtos.ScanResponse.Builder clearPartialFlagPerResult()

 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.
 

repeated bool partial_flag_per_result = 7;

hasMoreResultsInRegion

public boolean hasMoreResultsInRegion()

 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.
 

optional bool more_results_in_region = 8;

Specified by:

hasMoreResultsInRegion in interface ClientProtos.ScanResponseOrBuilder

getMoreResultsInRegion

public boolean getMoreResultsInRegion()

 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.
 

optional bool more_results_in_region = 8;

Specified by:

getMoreResultsInRegion in interface ClientProtos.ScanResponseOrBuilder

setMoreResultsInRegion

public ClientProtos.ScanResponse.Builder setMoreResultsInRegion(boolean value)

 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.
 

optional bool more_results_in_region = 8;

clearMoreResultsInRegion

public ClientProtos.ScanResponse.Builder clearMoreResultsInRegion()

 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.
 

optional bool more_results_in_region = 8;

hasHeartbeatMessage

public boolean hasHeartbeatMessage()

 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.
 

optional bool heartbeat_message = 9;

Specified by:

hasHeartbeatMessage in interface ClientProtos.ScanResponseOrBuilder

getHeartbeatMessage

public boolean getHeartbeatMessage()

 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.
 

optional bool heartbeat_message = 9;

Specified by:

getHeartbeatMessage in interface ClientProtos.ScanResponseOrBuilder

setHeartbeatMessage

public ClientProtos.ScanResponse.Builder setHeartbeatMessage(boolean value)

 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.
 

optional bool heartbeat_message = 9;

clearHeartbeatMessage

public ClientProtos.ScanResponse.Builder clearHeartbeatMessage()

 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.
 

optional bool heartbeat_message = 9;

hasScanMetrics

public boolean hasScanMetrics()

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

Specified by:

hasScanMetrics in interface ClientProtos.ScanResponseOrBuilder

getScanMetrics

public MapReduceProtos.ScanMetrics getScanMetrics()

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

Specified by:

getScanMetrics in interface ClientProtos.ScanResponseOrBuilder

setScanMetrics

public ClientProtos.ScanResponse.Builder setScanMetrics(MapReduceProtos.ScanMetrics value)

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

setScanMetrics

public ClientProtos.ScanResponse.Builder setScanMetrics(MapReduceProtos.ScanMetrics.Builder builderForValue)

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

mergeScanMetrics

public ClientProtos.ScanResponse.Builder mergeScanMetrics(MapReduceProtos.ScanMetrics value)

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

clearScanMetrics

public ClientProtos.ScanResponse.Builder clearScanMetrics()

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

getScanMetricsBuilder

public MapReduceProtos.ScanMetrics.Builder getScanMetricsBuilder()

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

getScanMetricsOrBuilder

public MapReduceProtos.ScanMetricsOrBuilder getScanMetricsOrBuilder()

 This field is filled in if the client has requested that scan metrics be tracked.
 The metrics tracked here are sent back to the client to be tracked together with
 the existing client side metrics.
 

optional .hbase.pb.ScanMetrics scan_metrics = 10;

Specified by:

getScanMetricsOrBuilder in interface ClientProtos.ScanResponseOrBuilder

hasMvccReadPoint

public boolean hasMvccReadPoint()

 The mvcc read point which is used to open the scanner at server side. Client can
 make use of this mvcc_read_point when restarting a scanner to get a consistent view
 of a row.
 

optional uint64 mvcc_read_point = 11 [default = 0];

Specified by:

hasMvccReadPoint in interface ClientProtos.ScanResponseOrBuilder

getMvccReadPoint

public long getMvccReadPoint()

 The mvcc read point which is used to open the scanner at server side. Client can
 make use of this mvcc_read_point when restarting a scanner to get a consistent view
 of a row.
 

optional uint64 mvcc_read_point = 11 [default = 0];

Specified by:

getMvccReadPoint in interface ClientProtos.ScanResponseOrBuilder

setMvccReadPoint

public ClientProtos.ScanResponse.Builder setMvccReadPoint(long value)

 The mvcc read point which is used to open the scanner at server side. Client can
 make use of this mvcc_read_point when restarting a scanner to get a consistent view
 of a row.
 

optional uint64 mvcc_read_point = 11 [default = 0];

clearMvccReadPoint

public ClientProtos.ScanResponse.Builder clearMvccReadPoint()

 The mvcc read point which is used to open the scanner at server side. Client can
 make use of this mvcc_read_point when restarting a scanner to get a consistent view
 of a row.
 

optional uint64 mvcc_read_point = 11 [default = 0];

hasCursor

public boolean hasCursor()

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

Specified by:

hasCursor in interface ClientProtos.ScanResponseOrBuilder

getCursor

public ClientProtos.Cursor getCursor()

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

Specified by:

getCursor in interface ClientProtos.ScanResponseOrBuilder

setCursor

public ClientProtos.ScanResponse.Builder setCursor(ClientProtos.Cursor value)

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

setCursor

public ClientProtos.ScanResponse.Builder setCursor(ClientProtos.Cursor.Builder builderForValue)

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

mergeCursor

public ClientProtos.ScanResponse.Builder mergeCursor(ClientProtos.Cursor value)

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

clearCursor

public ClientProtos.ScanResponse.Builder clearCursor()

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

getCursorBuilder

public ClientProtos.Cursor.Builder getCursorBuilder()

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

getCursorOrBuilder

public ClientProtos.CursorOrBuilder getCursorOrBuilder()

 If the Scan need cursor, return the row key we are scanning in heartbeat message.
 If the Scan doesn't need a cursor, don't set this field to reduce network IO.
 

optional .hbase.pb.Cursor cursor = 12;

Specified by:

getCursorOrBuilder in interface ClientProtos.ScanResponseOrBuilder

setUnknownFields

public final ClientProtos.ScanResponse.Builder setUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>

mergeUnknownFields

public final ClientProtos.ScanResponse.Builder mergeUnknownFields(org.apache.hbase.thirdparty.com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class org.apache.hbase.thirdparty.com.google.protobuf.GeneratedMessageV3.Builder<ClientProtos.ScanResponse.Builder>