public static final class ClientProtos.ScanResponse extends com.google.protobuf.GeneratedMessage implements ClientProtos.ScanResponseOrBuilder
hbase.pb.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.
| 限定符和类型 | 类和说明 |
|---|---|
static class |
ClientProtos.ScanResponse.Builder
Protobuf type
hbase.pb.ScanResponse
The scan response. |
com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>| 限定符和类型 | 字段和说明 |
|---|---|
static int |
CELLS_PER_RESULT_FIELD_NUMBER |
static int |
CURSOR_FIELD_NUMBER |
static int |
HEARTBEAT_MESSAGE_FIELD_NUMBER |
static int |
MORE_RESULTS_FIELD_NUMBER |
static int |
MORE_RESULTS_IN_REGION_FIELD_NUMBER |
static int |
MVCC_READ_POINT_FIELD_NUMBER |
static com.google.protobuf.Parser<ClientProtos.ScanResponse> |
PARSER |
static int |
PARTIAL_FLAG_PER_RESULT_FIELD_NUMBER |
static int |
RESULTS_FIELD_NUMBER |
static int |
SCAN_METRICS_FIELD_NUMBER |
static int |
SCANNER_ID_FIELD_NUMBER |
static int |
STALE_FIELD_NUMBER |
static int |
TTL_FIELD_NUMBER |
| 限定符和类型 | 方法和说明 |
|---|---|
boolean |
equals(Object obj) |
int |
getCellsPerResult(int index)
repeated uint32 cells_per_result = 1;
This field is filled in if we are doing cellblocks. |
int |
getCellsPerResultCount()
repeated uint32 cells_per_result = 1;
This field is filled in if we are doing cellblocks. |
List<Integer> |
getCellsPerResultList()
repeated uint32 cells_per_result = 1;
This field is filled in if we are doing cellblocks. |
ClientProtos.Cursor |
getCursor()
optional .hbase.pb.Cursor cursor = 12;
If the Scan need cursor, return the row key we are scanning in heartbeat message. |
ClientProtos.CursorOrBuilder |
getCursorOrBuilder()
optional .hbase.pb.Cursor cursor = 12;
If the Scan need cursor, return the row key we are scanning in heartbeat message. |
static ClientProtos.ScanResponse |
getDefaultInstance() |
ClientProtos.ScanResponse |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getHeartbeatMessage()
optional bool heartbeat_message = 9;
This field is filled in if the server is sending back a heartbeat message. |
boolean |
getMoreResults()
optional bool more_results = 3; |
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. |
long |
getMvccReadPoint()
optional uint64 mvcc_read_point = 11 [default = 0];
The mvcc read point which is used to open the scanner at server side. |
com.google.protobuf.Parser<ClientProtos.ScanResponse> |
getParserForType() |
boolean |
getPartialFlagPerResult(int index)
repeated bool partial_flag_per_result = 7;
This field is filled in if we are doing cellblocks. |
int |
getPartialFlagPerResultCount()
repeated bool partial_flag_per_result = 7;
This field is filled in if we are doing cellblocks. |
List<Boolean> |
getPartialFlagPerResultList()
repeated bool partial_flag_per_result = 7;
This field is filled in if we are doing cellblocks. |
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. |
int |
getResultsCount()
repeated .hbase.pb.Result results = 5;
If cells are not carried in an accompanying cellblock, then they are pb'd here. |
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. |
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. |
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. |
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. |
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. |
long |
getScannerId()
optional uint64 scanner_id = 2; |
int |
getSerializedSize() |
boolean |
getStale()
optional bool stale = 6; |
int |
getTtl()
optional uint32 ttl = 4; |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasCursor()
optional .hbase.pb.Cursor cursor = 12;
If the Scan need cursor, return the row key we are scanning in heartbeat message. |
int |
hashCode() |
boolean |
hasHeartbeatMessage()
optional bool heartbeat_message = 9;
This field is filled in if the server is sending back a heartbeat message. |
boolean |
hasMoreResults()
optional bool more_results = 3; |
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. |
boolean |
hasMvccReadPoint()
optional uint64 mvcc_read_point = 11 [default = 0];
The mvcc read point which is used to open the scanner at server side. |
boolean |
hasScanMetrics()
optional .hbase.pb.ScanMetrics scan_metrics = 10;
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 com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ClientProtos.ScanResponse.Builder |
newBuilder() |
static ClientProtos.ScanResponse.Builder |
newBuilder(ClientProtos.ScanResponse prototype) |
ClientProtos.ScanResponse.Builder |
newBuilderForType() |
protected ClientProtos.ScanResponse.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) |
static ClientProtos.ScanResponse |
parseDelimitedFrom(InputStream input) |
static ClientProtos.ScanResponse |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanResponse |
parseFrom(byte[] data) |
static ClientProtos.ScanResponse |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanResponse |
parseFrom(com.google.protobuf.ByteString data) |
static ClientProtos.ScanResponse |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanResponse |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClientProtos.ScanResponse |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClientProtos.ScanResponse |
parseFrom(InputStream input) |
static ClientProtos.ScanResponse |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ClientProtos.ScanResponse.Builder |
toBuilder() |
protected Object |
writeReplace() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownFieldfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringtoByteArray, toByteString, writeDelimitedTo, writeTopublic static com.google.protobuf.Parser<ClientProtos.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 final int MVCC_READ_POINT_FIELD_NUMBER
public static final int CURSOR_FIELD_NUMBER
public static ClientProtos.ScanResponse getDefaultInstance()
public ClientProtos.ScanResponse getDefaultInstanceForType()
getDefaultInstanceForType 在接口中 com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType 在接口中 com.google.protobuf.MessageOrBuilderpublic final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields 在接口中 com.google.protobuf.MessageOrBuildergetUnknownFields 在类中 com.google.protobuf.GeneratedMessagepublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable 在类中 com.google.protobuf.GeneratedMessagepublic com.google.protobuf.Parser<ClientProtos.ScanResponse> getParserForType()
getParserForType 在接口中 com.google.protobuf.MessagegetParserForType 在接口中 com.google.protobuf.MessageLitegetParserForType 在类中 com.google.protobuf.GeneratedMessagepublic 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.
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.
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.
public boolean hasScannerId()
optional uint64 scanner_id = 2;public long getScannerId()
optional uint64 scanner_id = 2;public boolean hasMoreResults()
optional bool more_results = 3;public boolean getMoreResults()
optional bool more_results = 3;public boolean hasTtl()
optional uint32 ttl = 4;hasTtl 在接口中 ClientProtos.ScanResponseOrBuilderpublic int getTtl()
optional uint32 ttl = 4;getTtl 在接口中 ClientProtos.ScanResponseOrBuilderpublic 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)
public 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)
public 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)
public 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)
getResults 在接口中 ClientProtos.ScanResponseOrBuilderpublic 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)
public boolean hasStale()
optional bool stale = 6;hasStale 在接口中 ClientProtos.ScanResponseOrBuilderpublic boolean getStale()
optional bool stale = 6;getStale 在接口中 ClientProtos.ScanResponseOrBuilderpublic 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.
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.
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.
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.
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.
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.
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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
hasCursor 在接口中 ClientProtos.ScanResponseOrBuilderpublic 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.
getCursor 在接口中 ClientProtos.ScanResponseOrBuilderpublic 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.
public final boolean isInitialized()
isInitialized 在接口中 com.google.protobuf.MessageLiteOrBuilderisInitialized 在类中 com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo 在接口中 com.google.protobuf.MessageLitewriteTo 在类中 com.google.protobuf.AbstractMessageIOExceptionpublic int getSerializedSize()
getSerializedSize 在接口中 com.google.protobuf.MessageLitegetSerializedSize 在类中 com.google.protobuf.AbstractMessageprotected Object writeReplace() throws ObjectStreamException
writeReplace 在类中 com.google.protobuf.GeneratedMessageObjectStreamExceptionpublic boolean equals(Object obj)
equals 在接口中 com.google.protobuf.Messageequals 在类中 com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode 在接口中 com.google.protobuf.MessagehashCode 在类中 com.google.protobuf.AbstractMessagepublic static ClientProtos.ScanResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClientProtos.ScanResponse parseFrom(InputStream input) throws IOException
IOExceptionpublic static ClientProtos.ScanResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClientProtos.ScanResponse parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ClientProtos.ScanResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClientProtos.ScanResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ClientProtos.ScanResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClientProtos.ScanResponse.Builder newBuilder()
public ClientProtos.ScanResponse.Builder newBuilderForType()
newBuilderForType 在接口中 com.google.protobuf.MessagenewBuilderForType 在接口中 com.google.protobuf.MessageLitepublic static ClientProtos.ScanResponse.Builder newBuilder(ClientProtos.ScanResponse prototype)
public ClientProtos.ScanResponse.Builder toBuilder()
toBuilder 在接口中 com.google.protobuf.MessagetoBuilder 在接口中 com.google.protobuf.MessageLiteprotected ClientProtos.ScanResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
newBuilderForType 在类中 com.google.protobuf.GeneratedMessageCopyright © 2007–2019. All rights reserved.