Package com.google.bigtable.v2
Class PartialResultSet.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
com.google.bigtable.v2.PartialResultSet.Builder
- All Implemented Interfaces:
PartialResultSetOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- PartialResultSet
public static final class PartialResultSet.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
implements PartialResultSetOrBuilder
A partial result set from the streaming query API. CBT client will buffer partial_rows from result_sets until it gets a resumption_token.Protobuf type
google.bigtable.v2.PartialResultSet-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()Estimated size of a new batch.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Partial rows in serialized ProtoRows format.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`.clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorintEstimated size of a new batch.Partial rows in serialized ProtoRows format.Partial rows in serialized ProtoRows format.Partial rows in serialized ProtoRows format.com.google.protobuf.ByteStringAn 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`.booleanPartial rows in serialized ProtoRows format.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(PartialResultSet other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Partial rows in serialized ProtoRows format.final PartialResultSet.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setEstimatedBatchSize(int value) Estimated size of a new batch.setProtoRowsBatch(ProtoRowsBatch value) Partial rows in serialized ProtoRows format.setProtoRowsBatch(ProtoRowsBatch.Builder builderForValue) Partial rows in serialized ProtoRows format.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setResumeToken(com.google.protobuf.ByteString value) 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`.final PartialResultSet.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
setField
public PartialResultSet.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
setRepeatedField
public PartialResultSet.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
addRepeatedField
public PartialResultSet.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<PartialResultSet.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
mergeFrom
public PartialResultSet.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<PartialResultSet.Builder>- Throws:
IOException
-
getPartialRowsCase
- Specified by:
getPartialRowsCasein interfacePartialResultSetOrBuilder
-
clearPartialRows
-
hasProtoRowsBatch
public boolean hasProtoRowsBatch()Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;- Specified by:
hasProtoRowsBatchin interfacePartialResultSetOrBuilder- Returns:
- Whether the protoRowsBatch field is set.
-
getProtoRowsBatch
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;- Specified by:
getProtoRowsBatchin interfacePartialResultSetOrBuilder- Returns:
- The protoRowsBatch.
-
setProtoRowsBatch
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3; -
setProtoRowsBatch
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3; -
mergeProtoRowsBatch
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3; -
clearProtoRowsBatch
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3; -
getProtoRowsBatchBuilder
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3; -
getProtoRowsBatchOrBuilder
Partial rows in serialized ProtoRows format.
.google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;- Specified by:
getProtoRowsBatchOrBuilderin interfacePartialResultSetOrBuilder
-
getResumeToken
public 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;- Specified by:
getResumeTokenin interfacePartialResultSetOrBuilder- Returns:
- The resumeToken.
-
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.
bytes resume_token = 5;- Parameters:
value- The resumeToken to set.- Returns:
- This builder for chaining.
-
clearResumeToken
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:
- This builder for chaining.
-
getEstimatedBatchSize
public 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;- Specified by:
getEstimatedBatchSizein interfacePartialResultSetOrBuilder- Returns:
- The estimatedBatchSize.
-
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.
int32 estimated_batch_size = 4;- Parameters:
value- The estimatedBatchSize to set.- Returns:
- This builder for chaining.
-
clearEstimatedBatchSize
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:
- This builder for chaining.
-
setUnknownFields
public final PartialResultSet.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-
mergeUnknownFields
public final PartialResultSet.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
-