public static final class PartialResultSet.Builder extends com.google.protobuf.GeneratedMessage.Builder<PartialResultSet.Builder> implements PartialResultSetOrBuilder
A partial result set from the streaming query API.
Cloud Bigtable clients buffer partial results received in this message until
a `resume_token` is received.
The pseudocode below describes how to buffer and parse a stream of
`PartialResultSet` messages.
Having:
- queue of row results waiting to be returned `queue`
- extensible buffer of bytes `buffer`
- a place to keep track of the most recent `resume_token`
for each PartialResultSet `p` received {
if p.reset {
ensure `queue` is empty
ensure `buffer` is empty
}
if p.estimated_batch_size != 0 {
(optional) ensure `buffer` is sized to at least `p.estimated_batch_size`
}
if `p.proto_rows_batch` is set {
append `p.proto_rows_batch.bytes` to `buffer`
}
if p.batch_checksum is set and `buffer` is not empty {
validate the checksum matches the contents of `buffer`
(see comments on `batch_checksum`)
parse `buffer` as `ProtoRows` message, clearing `buffer`
add parsed rows to end of `queue`
}
if p.resume_token is set {
release results in `queue`
save `p.resume_token` in `resume_token`
}
}
Protobuf type google.bigtable.v2.PartialResultSet| Modifier and Type | Method and Description |
|---|---|
PartialResultSet |
build() |
PartialResultSet |
buildPartial() |
PartialResultSet.Builder |
clear() |
PartialResultSet.Builder |
clearBatchChecksum()
CRC32C checksum of concatenated `partial_rows` data for the current batch.
|
PartialResultSet.Builder |
clearEstimatedBatchSize()
Estimated size of the buffer required to hold the next batch of results.
|
PartialResultSet.Builder |
clearPartialRows() |
PartialResultSet.Builder |
clearProtoRowsBatch()
Partial rows in serialized ProtoRows format.
|
PartialResultSet.Builder |
clearReset()
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.
|
PartialResultSet.Builder |
clearResumeToken()
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.
|
int |
getBatchChecksum()
CRC32C checksum of concatenated `partial_rows` data for the current batch.
|
PartialResultSet |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
ProtoRowsBatch.Builder |
getProtoRowsBatchBuilder()
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.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PartialResultSet.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PartialResultSet.Builder |
mergeFrom(com.google.protobuf.Message other) |
PartialResultSet.Builder |
mergeFrom(PartialResultSet other) |
PartialResultSet.Builder |
mergeProtoRowsBatch(ProtoRowsBatch value)
Partial rows in serialized ProtoRows format.
|
PartialResultSet.Builder |
setBatchChecksum(int value)
CRC32C checksum of concatenated `partial_rows` data for the current batch.
|
PartialResultSet.Builder |
setEstimatedBatchSize(int value)
Estimated size of the buffer required to hold the next batch of results.
|
PartialResultSet.Builder |
setProtoRowsBatch(ProtoRowsBatch.Builder builderForValue)
Partial rows in serialized ProtoRows format.
|
PartialResultSet.Builder |
setProtoRowsBatch(ProtoRowsBatch value)
Partial rows in serialized ProtoRows format.
|
PartialResultSet.Builder |
setReset(boolean value)
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.
|
PartialResultSet.Builder |
setResumeToken(com.google.protobuf.ByteString value)
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.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PartialResultSet.Builder>public PartialResultSet.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<PartialResultSet.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PartialResultSet.Builder>public PartialResultSet getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PartialResultSet build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PartialResultSet buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PartialResultSet.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartialResultSet.Builder>public PartialResultSet.Builder mergeFrom(PartialResultSet other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<PartialResultSet.Builder>public PartialResultSet.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartialResultSet.Builder>IOExceptionpublic PartialResultSet.PartialRowsCase getPartialRowsCase()
getPartialRowsCase in interface PartialResultSetOrBuilderpublic PartialResultSet.Builder clearPartialRows()
public boolean hasProtoRowsBatch()
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;hasProtoRowsBatch in interface PartialResultSetOrBuilderpublic ProtoRowsBatch getProtoRowsBatch()
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;getProtoRowsBatch in interface PartialResultSetOrBuilderpublic PartialResultSet.Builder setProtoRowsBatch(ProtoRowsBatch value)
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;public PartialResultSet.Builder setProtoRowsBatch(ProtoRowsBatch.Builder builderForValue)
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;public PartialResultSet.Builder mergeProtoRowsBatch(ProtoRowsBatch value)
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;public PartialResultSet.Builder clearProtoRowsBatch()
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;public ProtoRowsBatch.Builder getProtoRowsBatchBuilder()
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;public ProtoRowsBatchOrBuilder getProtoRowsBatchOrBuilder()
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;getProtoRowsBatchOrBuilder in interface PartialResultSetOrBuilderpublic 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;hasBatchChecksum in interface PartialResultSetOrBuilderpublic 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;getBatchChecksum in interface PartialResultSetOrBuilderpublic PartialResultSet.Builder setBatchChecksum(int value)
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;value - The batchChecksum to set.public PartialResultSet.Builder clearBatchChecksum()
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;public 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;getResumeToken in interface PartialResultSetOrBuilderpublic PartialResultSet.Builder setResumeToken(com.google.protobuf.ByteString value)
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;value - The resumeToken to set.public PartialResultSet.Builder clearResumeToken()
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;public 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;getReset in interface PartialResultSetOrBuilderpublic PartialResultSet.Builder setReset(boolean value)
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;value - The reset to set.public PartialResultSet.Builder clearReset()
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;public 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;getEstimatedBatchSize in interface PartialResultSetOrBuilderpublic PartialResultSet.Builder setEstimatedBatchSize(int value)
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;value - The estimatedBatchSize to set.public PartialResultSet.Builder clearEstimatedBatchSize()
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;Copyright © 2026 Google LLC. All rights reserved.