Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::PartialResultSet (v1.5.0)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::PartialResultSet.

A partial result set from the streaming query API. CBT client will buffer partial_rows from result_sets until it gets a resumption_token.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#estimated_batch_size

def estimated_batch_size() -> ::Integer
Returns
  • (::Integer) — 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.

#estimated_batch_size=

def estimated_batch_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#proto_rows_batch

def proto_rows_batch() -> ::Google::Cloud::Bigtable::V2::ProtoRowsBatch
Returns

#proto_rows_batch=

def proto_rows_batch=(value) -> ::Google::Cloud::Bigtable::V2::ProtoRowsBatch
Parameter
Returns

#resume_token

def resume_token() -> ::String
Returns
  • (::String) — 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.

#resume_token=

def resume_token=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.