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

Interface ClientProtos.ScanResponseOrBuilder

All Superinterfaces:

org.apache.hbase.thirdparty.com.google.protobuf.MessageLiteOrBuilder, org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ClientProtos.ScanResponse, ClientProtos.ScanResponse.Builder

Enclosing class:

ClientProtos

public static interface ClientProtos.ScanResponseOrBuilder
extends org.apache.hbase.thirdparty.com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.CursorOrBuilder	getCursorOrBuilder() If the Scan need cursor, return the row key we are scanning in heartbeat message.
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.
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.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;

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

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

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

isInitialized

Method Detail

getCellsPerResultList

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;

getCellsPerResultCount

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;

getCellsPerResult

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;

hasScannerId

boolean hasScannerId()

optional uint64 scanner_id = 2;

getScannerId

long getScannerId()

optional uint64 scanner_id = 2;

hasMoreResults

boolean hasMoreResults()

optional bool more_results = 3;

getMoreResults

boolean getMoreResults()

optional bool more_results = 3;

hasTtl

boolean hasTtl()

optional uint32 ttl = 4;

getTtl

int getTtl()

optional uint32 ttl = 4;

getResultsList

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;

getResults

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;

getResultsCount

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;

getResultsOrBuilderList

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;

getResultsOrBuilder

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;

hasStale

boolean hasStale()

optional bool stale = 6;

getStale

boolean getStale()

optional bool stale = 6;

getPartialFlagPerResultList

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;

getPartialFlagPerResultCount

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;

getPartialFlagPerResult

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;

hasMoreResultsInRegion

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;

getMoreResultsInRegion

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;

hasHeartbeatMessage

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;

getHeartbeatMessage

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;

hasScanMetrics

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;

getScanMetrics

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;

getScanMetricsOrBuilder

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;

hasMvccReadPoint

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];

getMvccReadPoint

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];

hasCursor

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;

getCursor

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;

getCursorOrBuilder

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;