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
    Estimated size of a new batch.
     
    Partial rows in serialized ProtoRows format.
    Partial rows in serialized ProtoRows format.
    com.google.protobuf.ByteString
    An opaque token sent by the server to allow query resumption and signal the client to accumulate `partial_rows` since the last non-empty `resume_token`.
    boolean
    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;
    • getResumeToken

      com.google.protobuf.ByteString getResumeToken()
       An opaque token sent by the server to allow query resumption and signal
       the client to accumulate `partial_rows` since the last non-empty
       `resume_token`. On resumption, the resumed query will return the remaining
       rows for this query.
      
       If there is a batch in progress, a non-empty `resume_token`
       means that that the batch of `partial_rows` will be complete after merging
       the `partial_rows` from this response. The client must only yield
       completed batches to the application, and must ensure that any future
       retries send the latest token to avoid returning duplicate data.
      
       The server may set 'resume_token' without a 'partial_rows'. If there is a
       batch in progress the client should yield it.
      
       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
       `partial_rows`, then return OK.
       
      bytes resume_token = 5;
      Returns:
      The resumeToken.
    • getEstimatedBatchSize

      int getEstimatedBatchSize()
       Estimated size of a new batch. The server will always set this when
       returning the first `partial_rows` of a batch, and will not set it at any
       other time.
      
       The client can use this estimate to allocate an initial buffer for the
       batched 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()