Reference documentation and code samples for the Cloud Bigtable V2 Client class 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.
Generated from protobuf message google.bigtable.v2.PartialResultSet
Namespace
Google \ Cloud \ Bigtable \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ proto_rows_batch
↳ resume_token
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.
↳ estimated_batch_size
int
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.
getProtoRowsBatch
Partial rows in serialized ProtoRows format.
hasProtoRowsBatch
setProtoRowsBatch
Partial rows in serialized ProtoRows format.
$this
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.
string
setResumeToken
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.
var
string
$this
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.
int
setEstimatedBatchSize
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.
var
int
$this
getPartialRows
string
