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 Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • clear

      public PartialResultSet.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • getDefaultInstanceForType

      public PartialResultSet getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public PartialResultSet build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public PartialResultSet buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • clone

      public PartialResultSet.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • setField

      public PartialResultSet.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • clearField

      public PartialResultSet.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • clearOneof

      public PartialResultSet.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • setRepeatedField

      public PartialResultSet.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • addRepeatedField

      public PartialResultSet.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • mergeFrom

      public PartialResultSet.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartialResultSet.Builder>
    • mergeFrom

      public PartialResultSet.Builder mergeFrom(PartialResultSet other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.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:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PartialResultSet.Builder>
      Throws:
      IOException
    • getPartialRowsCase

      public PartialResultSet.PartialRowsCase getPartialRowsCase()
      Specified by:
      getPartialRowsCase in interface PartialResultSetOrBuilder
    • clearPartialRows

      public PartialResultSet.Builder clearPartialRows()
    • hasProtoRowsBatch

      public boolean hasProtoRowsBatch()
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
      Specified by:
      hasProtoRowsBatch in interface PartialResultSetOrBuilder
      Returns:
      Whether the protoRowsBatch field is set.
    • getProtoRowsBatch

      public ProtoRowsBatch getProtoRowsBatch()
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
      Specified by:
      getProtoRowsBatch in interface PartialResultSetOrBuilder
      Returns:
      The protoRowsBatch.
    • setProtoRowsBatch

      public PartialResultSet.Builder setProtoRowsBatch(ProtoRowsBatch value)
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
    • setProtoRowsBatch

      public PartialResultSet.Builder setProtoRowsBatch(ProtoRowsBatch.Builder builderForValue)
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
    • mergeProtoRowsBatch

      public PartialResultSet.Builder mergeProtoRowsBatch(ProtoRowsBatch value)
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
    • clearProtoRowsBatch

      public PartialResultSet.Builder clearProtoRowsBatch()
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
    • getProtoRowsBatchBuilder

      public ProtoRowsBatch.Builder getProtoRowsBatchBuilder()
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
    • getProtoRowsBatchOrBuilder

      public ProtoRowsBatchOrBuilder getProtoRowsBatchOrBuilder()
       Partial rows in serialized ProtoRows format.
       
      .google.bigtable.v2.ProtoRowsBatch proto_rows_batch = 3;
      Specified by:
      getProtoRowsBatchOrBuilder in interface PartialResultSetOrBuilder
    • 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:
      getResumeToken in interface PartialResultSetOrBuilder
      Returns:
      The resumeToken.
    • setResumeToken

      public PartialResultSet.Builder 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`. 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

      public PartialResultSet.Builder 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:
      getEstimatedBatchSize in interface PartialResultSetOrBuilder
      Returns:
      The estimatedBatchSize.
    • setEstimatedBatchSize

      public PartialResultSet.Builder setEstimatedBatchSize(int value)
       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

      public PartialResultSet.Builder 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:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>
    • mergeUnknownFields

      public final PartialResultSet.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PartialResultSet.Builder>