org.apache.hadoop.hbase.protobuf.generated

Interface ClientProtos.ScanResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ClientProtos.ScanResponse, ClientProtos.ScanResponse.Builder

Enclosing class:

ClientProtos

public static interface ClientProtos.ScanResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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;
ClientProtos.Cursor	getCursor() optional .hbase.pb.Cursor cursor = 12;
ClientProtos.CursorOrBuilder	getCursorOrBuilder() optional .hbase.pb.Cursor cursor = 12;
boolean	getHeartbeatMessage() optional bool heartbeat_message = 9;
boolean	getMoreResults() optional bool more_results = 3;
boolean	getMoreResultsInRegion() optional bool more_results_in_region = 8;
long	getMvccReadPoint() optional uint64 mvcc_read_point = 11 [default = 0];
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 .hbase.pb.Result results = 5;
int	getResultsCount() repeated .hbase.pb.Result results = 5;
List<ClientProtos.Result>	getResultsList() repeated .hbase.pb.Result results = 5;
ClientProtos.ResultOrBuilder	getResultsOrBuilder(int index) repeated .hbase.pb.Result results = 5;
List<? extends ClientProtos.ResultOrBuilder>	getResultsOrBuilderList() repeated .hbase.pb.Result results = 5;
MapReduceProtos.ScanMetrics	getScanMetrics() optional .hbase.pb.ScanMetrics scan_metrics = 10;
MapReduceProtos.ScanMetricsOrBuilder	getScanMetricsOrBuilder() optional .hbase.pb.ScanMetrics scan_metrics = 10;
long	getScannerId() optional uint64 scanner_id = 2;
boolean	getStale() optional bool stale = 6;
int	getTtl() optional uint32 ttl = 4;
boolean	hasCursor() optional .hbase.pb.Cursor cursor = 12;
boolean	hasHeartbeatMessage() optional bool heartbeat_message = 9;
boolean	hasMoreResults() optional bool more_results = 3;
boolean	hasMoreResultsInRegion() optional bool more_results_in_region = 8;
boolean	hasMvccReadPoint() optional uint64 mvcc_read_point = 11 [default = 0];
boolean	hasScanMetrics() optional .hbase.pb.ScanMetrics scan_metrics = 10;
boolean	hasScannerId() optional uint64 scanner_id = 2;
boolean	hasStale() optional bool stale = 6;
boolean	hasTtl() optional uint32 ttl = 4;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCellsPerResultList

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.
 

getCellsPerResultCount

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.
 

getCellsPerResult

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.
 

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()

repeated .hbase.pb.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)
 

getResults

ClientProtos.Result getResults(int index)

repeated .hbase.pb.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)
 

getResultsCount

int getResultsCount()

repeated .hbase.pb.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)
 

getResultsOrBuilderList

List<? extends ClientProtos.ResultOrBuilder> getResultsOrBuilderList()

repeated .hbase.pb.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)
 

getResultsOrBuilder

ClientProtos.ResultOrBuilder getResultsOrBuilder(int index)

repeated .hbase.pb.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)
 

hasStale

boolean hasStale()

optional bool stale = 6;

getStale

boolean getStale()

optional bool stale = 6;

getPartialFlagPerResultList

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.
 

getPartialFlagPerResultCount

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.
 

getPartialFlagPerResult

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.
 

hasMoreResultsInRegion

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.
 

getMoreResultsInRegion

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.
 

hasHeartbeatMessage

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.
 

getHeartbeatMessage

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.
 

hasScanMetrics

boolean hasScanMetrics()

optional .hbase.pb.ScanMetrics scan_metrics = 10;

 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.
 

getScanMetrics

MapReduceProtos.ScanMetrics getScanMetrics()

optional .hbase.pb.ScanMetrics scan_metrics = 10;

 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.
 

getScanMetricsOrBuilder

MapReduceProtos.ScanMetricsOrBuilder getScanMetricsOrBuilder()

optional .hbase.pb.ScanMetrics scan_metrics = 10;

 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.
 

hasMvccReadPoint

boolean hasMvccReadPoint()

optional uint64 mvcc_read_point = 11 [default = 0];

 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.
 

getMvccReadPoint

long getMvccReadPoint()

optional uint64 mvcc_read_point = 11 [default = 0];

 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.
 

hasCursor

boolean hasCursor()

optional .hbase.pb.Cursor cursor = 12;

 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.
 

getCursor

ClientProtos.Cursor getCursor()

optional .hbase.pb.Cursor cursor = 12;

 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.
 

getCursorOrBuilder

ClientProtos.CursorOrBuilder getCursorOrBuilder()

optional .hbase.pb.Cursor cursor = 12;

 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.