public static final class ClientPB.ScanResponse extends com.google.protobuf.GeneratedMessageLite implements ClientPB.ScanResponseOrBuilder
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.
Modifier and Type | Class and Description |
---|---|
static class |
ClientPB.ScanResponse.Builder
Protobuf type
ScanResponse |
com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>
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<ClientPB.ScanResponse> |
PARSER |
static int |
PARTIAL_FLAG_PER_RESULT_FIELD_NUMBER |
static int |
RESULTS_FIELD_NUMBER |
static int |
SCAN_METRICS_FIELD_NUMBER |
static int |
SCANNER_ID_FIELD_NUMBER |
static int |
STALE_FIELD_NUMBER |
static int |
TTL_FIELD_NUMBER |
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; |
static ClientPB.ScanResponse |
getDefaultInstance() |
ClientPB.ScanResponse |
getDefaultInstanceForType() |
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<ClientPB.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; |
ClientPB.Result |
getResults(int index)
repeated .Result results = 5; |
int |
getResultsCount()
repeated .Result results = 5; |
List<ClientPB.Result> |
getResultsList()
repeated .Result results = 5; |
ClientPB.ResultOrBuilder |
getResultsOrBuilder(int index)
repeated .Result results = 5; |
List<? extends ClientPB.ResultOrBuilder> |
getResultsOrBuilderList()
repeated .Result results = 5; |
MapReducePB.ScanMetrics |
getScanMetrics()
optional .ScanMetrics scan_metrics = 10; |
long |
getScannerId()
optional uint64 scanner_id = 2; |
int |
getSerializedSize() |
boolean |
getStale()
optional bool stale = 6; |
int |
getTtl()
optional uint32 ttl = 4; |
boolean |
hasHeartbeatMessage()
optional bool heartbeat_message = 9; |
boolean |
hasMoreResults()
optional bool more_results = 3; |
boolean |
hasMoreResultsInRegion()
optional bool more_results_in_region = 8; |
boolean |
hasScanMetrics()
optional .ScanMetrics scan_metrics = 10; |
boolean |
hasScannerId()
optional uint64 scanner_id = 2; |
boolean |
hasStale()
optional bool stale = 6; |
boolean |
hasTtl()
optional uint32 ttl = 4; |
boolean |
isInitialized() |
static ClientPB.ScanResponse.Builder |
newBuilder() |
static ClientPB.ScanResponse.Builder |
newBuilder(ClientPB.ScanResponse prototype) |
ClientPB.ScanResponse.Builder |
newBuilderForType() |
static ClientPB.ScanResponse |
parseDelimitedFrom(InputStream input) |
static ClientPB.ScanResponse |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.ScanResponse |
parseFrom(byte[] data) |
static ClientPB.ScanResponse |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.ScanResponse |
parseFrom(com.google.protobuf.ByteString data) |
static ClientPB.ScanResponse |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.ScanResponse |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClientPB.ScanResponse |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientPB.ScanResponse |
parseFrom(InputStream input) |
static ClientPB.ScanResponse |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ClientPB.ScanResponse.Builder |
toBuilder() |
protected Object |
writeReplace() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
makeExtensionsImmutable, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseUnknownField
public static com.google.protobuf.Parser<ClientPB.ScanResponse> PARSER
public static final int CELLS_PER_RESULT_FIELD_NUMBER
public static final int SCANNER_ID_FIELD_NUMBER
public static final int MORE_RESULTS_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
public static final int STALE_FIELD_NUMBER
public static final int PARTIAL_FLAG_PER_RESULT_FIELD_NUMBER
public static final int MORE_RESULTS_IN_REGION_FIELD_NUMBER
public static final int HEARTBEAT_MESSAGE_FIELD_NUMBER
public static final int SCAN_METRICS_FIELD_NUMBER
public static ClientPB.ScanResponse getDefaultInstance()
public ClientPB.ScanResponse getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
public com.google.protobuf.Parser<ClientPB.ScanResponse> getParserForType()
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageLite
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.
getCellsPerResultList
in interface ClientPB.ScanResponseOrBuilder
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.
getCellsPerResultCount
in interface ClientPB.ScanResponseOrBuilder
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.
getCellsPerResult
in interface ClientPB.ScanResponseOrBuilder
public boolean hasScannerId()
optional uint64 scanner_id = 2;
hasScannerId
in interface ClientPB.ScanResponseOrBuilder
public long getScannerId()
optional uint64 scanner_id = 2;
getScannerId
in interface ClientPB.ScanResponseOrBuilder
public boolean hasMoreResults()
optional bool more_results = 3;
hasMoreResults
in interface ClientPB.ScanResponseOrBuilder
public boolean getMoreResults()
optional bool more_results = 3;
getMoreResults
in interface ClientPB.ScanResponseOrBuilder
public boolean hasTtl()
optional uint32 ttl = 4;
hasTtl
in interface ClientPB.ScanResponseOrBuilder
public int getTtl()
optional uint32 ttl = 4;
getTtl
in interface ClientPB.ScanResponseOrBuilder
public List<ClientPB.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)
getResultsList
in interface ClientPB.ScanResponseOrBuilder
public List<? extends ClientPB.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)
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)
getResultsCount
in interface ClientPB.ScanResponseOrBuilder
public ClientPB.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)
getResults
in interface ClientPB.ScanResponseOrBuilder
public ClientPB.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)
public boolean hasStale()
optional bool stale = 6;
hasStale
in interface ClientPB.ScanResponseOrBuilder
public boolean getStale()
optional bool stale = 6;
getStale
in interface ClientPB.ScanResponseOrBuilder
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.
getPartialFlagPerResultList
in interface ClientPB.ScanResponseOrBuilder
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.
getPartialFlagPerResultCount
in interface ClientPB.ScanResponseOrBuilder
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.
getPartialFlagPerResult
in interface ClientPB.ScanResponseOrBuilder
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.
hasMoreResultsInRegion
in interface ClientPB.ScanResponseOrBuilder
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.
getMoreResultsInRegion
in interface ClientPB.ScanResponseOrBuilder
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.
hasHeartbeatMessage
in interface ClientPB.ScanResponseOrBuilder
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.
getHeartbeatMessage
in interface ClientPB.ScanResponseOrBuilder
public boolean hasScanMetrics()
optional .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.
hasScanMetrics
in interface ClientPB.ScanResponseOrBuilder
public MapReducePB.ScanMetrics getScanMetrics()
optional .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
in interface ClientPB.ScanResponseOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
protected Object writeReplace() throws ObjectStreamException
writeReplace
in class com.google.protobuf.GeneratedMessageLite
ObjectStreamException
public static ClientPB.ScanResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.ScanResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.ScanResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.ScanResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ClientPB.ScanResponse parseFrom(InputStream input) throws IOException
IOException
public static ClientPB.ScanResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ClientPB.ScanResponse parseDelimitedFrom(InputStream input) throws IOException
IOException
public static ClientPB.ScanResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ClientPB.ScanResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static ClientPB.ScanResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ClientPB.ScanResponse.Builder newBuilder()
public ClientPB.ScanResponse.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.MessageLite
public static ClientPB.ScanResponse.Builder newBuilder(ClientPB.ScanResponse prototype)
public ClientPB.ScanResponse.Builder toBuilder()
toBuilder
in interface com.google.protobuf.MessageLite
Copyright © 2010-2017, The Async HBase Authors