Package com.google.bigtable.v2

Interface PartialResultSetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PartialResultSet, PartialResultSet.Builder
public interface PartialResultSetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBatchChecksum()
    CRC32C checksum of concatenated `partial_rows` data for the current batch.
    int
    getEstimatedBatchSize()
    Estimated size of the buffer required to hold the next batch of results.
    PartialResultSet.PartialRowsCase
    getPartialRowsCase()
     
    ProtoRowsBatch
    getProtoRowsBatch()
    Partial rows in serialized ProtoRows format.
    ProtoRowsBatchOrBuilder
    getProtoRowsBatchOrBuilder()
    Partial rows in serialized ProtoRows format.
    boolean
    getReset()
    If `true`, any data buffered since the last non-empty `resume_token` must be discarded before the other parts of this message, if any, are handled.
    com.google.protobuf.ByteString
    getResumeToken()
    An opaque token sent by the server to allow query resumption and signal that the buffered values constructed from received `partial_rows` can be yielded to the caller.
    boolean
    hasBatchChecksum()
    CRC32C checksum of concatenated `partial_rows` data for the current batch.
    boolean
    hasProtoRowsBatch()
    Partial rows in serialized ProtoRows format.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasProtoRowsBatch

      boolean hasProtoRowsBatch()
       Partial rows in serialized ProtoRows format.
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
      Returns:
      Whether the protoRowsBatch field is set.

    • getProtoRowsBatch

      ProtoRowsBatch getProtoRowsBatch()
       Partial rows in serialized ProtoRows format.
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
      Returns:
      The protoRowsBatch.

    • getProtoRowsBatchOrBuilder

      ProtoRowsBatchOrBuilder getProtoRowsBatchOrBuilder()
       Partial rows in serialized ProtoRows format.
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;

    • hasBatchChecksum

      boolean hasBatchChecksum()
       CRC32C checksum of concatenated `partial_rows` data for the current batch.

 When present, the buffered data from `partial_rows` forms a complete
 parseable message of the appropriate type.

 The client should mark the end of a parseable message and prepare to
 receive a new one starting from the next `PartialResultSet` message.
 Clients must verify the checksum of the serialized batch before yielding it
 to the caller.

 This does NOT mean the values can be yielded to the callers since a
 `resume_token` is required to safely do so.

 If `resume_token` is non-empty and any data has been received since the
 last one, this field is guaranteed to be non-empty. In other words, clients
 may assume that a batch will never cross a `resume_token` boundary.
      optional uint32 batch_checksum = 6;
      Returns:
      Whether the batchChecksum field is set.

    • getBatchChecksum

      int getBatchChecksum()
       CRC32C checksum of concatenated `partial_rows` data for the current batch.

 When present, the buffered data from `partial_rows` forms a complete
 parseable message of the appropriate type.

 The client should mark the end of a parseable message and prepare to
 receive a new one starting from the next `PartialResultSet` message.
 Clients must verify the checksum of the serialized batch before yielding it
 to the caller.

 This does NOT mean the values can be yielded to the callers since a
 `resume_token` is required to safely do so.

 If `resume_token` is non-empty and any data has been received since the
 last one, this field is guaranteed to be non-empty. In other words, clients
 may assume that a batch will never cross a `resume_token` boundary.
      optional uint32 batch_checksum = 6;
      Returns:
      The batchChecksum.

    • getResumeToken

      com.google.protobuf.ByteString getResumeToken()
       An opaque token sent by the server to allow query resumption and signal
 that the buffered values constructed from received `partial_rows` can be
 yielded to the caller. Clients can provide this token in a subsequent
 request to resume the result stream from the current point.

 When `resume_token` is non-empty, the buffered values received from
 `partial_rows` since the last non-empty `resume_token` can be yielded to
 the callers, provided that the client keeps the value of `resume_token` and
 uses it on subsequent retries.

 A `resume_token` may be sent without information in `partial_rows` to
 checkpoint the progress of a sparse query. Any previous `partial_rows` data
 should still be yielded in this case, and the new `resume_token` should be
 saved for future retries as normal.

 A `resume_token` will only be sent on a boundary where there is either no
 ongoing result batch, or `batch_checksum` is also populated.

 The server will also send a sentinel `resume_token` when last batch of
 `partial_rows` is sent. If the client retries the ExecuteQueryRequest with
 the sentinel `resume_token`, the server will emit it again without any
 data in `partial_rows`, then return OK.
      bytes resume_token = 5;
      Returns:
      The resumeToken.

    • getReset

      boolean getReset()
       If `true`, any data buffered since the last non-empty `resume_token` must
 be discarded before the other parts of this message, if any, are handled.
      bool reset = 7;
      Returns:
      The reset.

    • getEstimatedBatchSize

      int getEstimatedBatchSize()
       Estimated size of the buffer required to hold the next batch of results.

 This value will be sent with the first `partial_rows` of a batch. That is,
 on the first `partial_rows` received in a stream, on the first message
 after a `batch_checksum` message, and any time `reset` is true.

 The client can use this estimate to allocate a buffer for the next batch of
 results. This helps minimize the number of allocations required, though the
 buffer size may still need to be increased if the estimate is too low.
      int32 estimated_batch_size = 4;
      Returns:
      The estimatedBatchSize.

    • getPartialRowsCase

      PartialResultSet.PartialRowsCase getPartialRowsCase()