Google Bigtable v2 API - Class PartialResultSet (3.15.0) 

public sealed class PartialResultSet : IMessage<PartialResultSet>, IEquatable<PartialResultSet>, IDeepCloneable<PartialResultSet>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API 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.

Inheritance

object > PartialResultSet

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

PartialResultSet()

public PartialResultSet()

PartialResultSet(PartialResultSet)

public PartialResultSet(PartialResultSet other)
Parameter
Name Description
other PartialResultSet

Properties

EstimatedBatchSize

public int EstimatedBatchSize { get; set; }

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.

Property Value
Type Description
int

PartialRowsCase

public PartialResultSet.PartialRowsOneofCase PartialRowsCase { get; }
Property Value
Type Description
PartialResultSetPartialRowsOneofCase

ProtoRowsBatch

public ProtoRowsBatch ProtoRowsBatch { get; set; }

Partial rows in serialized ProtoRows format.

Property Value
Type Description
ProtoRowsBatch

ResumeToken

public ByteString ResumeToken { get; set; }

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.

Property Value
Type Description
ByteString