Package com.google.firestore.v1

Class RunAggregationQueryResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RunAggregationQueryResponse.Builder>
com.google.firestore.v1.RunAggregationQueryResponse.Builder
All Implemented Interfaces:
RunAggregationQueryResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RunAggregationQueryResponse
public static final class RunAggregationQueryResponse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RunAggregationQueryResponse.Builder> implements RunAggregationQueryResponseOrBuilder
 The response for
 [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].
Protobuf type google.firestore.v1.RunAggregationQueryResponse

  • 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<RunAggregationQueryResponse.Builder>

    • clear

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • getDefaultInstanceForType

      public RunAggregationQueryResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • setField

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • clearField

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • clearOneof

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • setRepeatedField

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • addRepeatedField

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • mergeFrom

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • mergeFrom

      public RunAggregationQueryResponse.Builder mergeFrom(RunAggregationQueryResponse other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunAggregationQueryResponse.Builder>

    • mergeFrom

      public RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>
      Throws:
      IOException

    • hasResult

      public boolean hasResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Specified by:
      hasResult in interface RunAggregationQueryResponseOrBuilder
      Returns:
      Whether the result field is set.

    • getResult

      public AggregationResult getResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Specified by:
      getResult in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The result.

    • setResult

      public RunAggregationQueryResponse.Builder setResult(AggregationResult value)
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;

    • setResult

      public RunAggregationQueryResponse.Builder setResult(AggregationResult.Builder builderForValue)
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;

    • mergeResult

      public RunAggregationQueryResponse.Builder mergeResult(AggregationResult value)
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;

    • clearResult

      public RunAggregationQueryResponse.Builder clearResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;

    • getResultBuilder

      public AggregationResult.Builder getResultBuilder()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;

    • getResultOrBuilder

      public AggregationResultOrBuilder getResultOrBuilder()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Specified by:
      getResultOrBuilder in interface RunAggregationQueryResponseOrBuilder

    • getTransaction

      public com.google.protobuf.ByteString getTransaction()
       The transaction that was started as part of this request.

 Only present on the first response when the request requested to start
 a new transaction.
      bytes transaction = 2;
      Specified by:
      getTransaction in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The transaction.

    • setTransaction

      public RunAggregationQueryResponse.Builder setTransaction(com.google.protobuf.ByteString value)
       The transaction that was started as part of this request.

 Only present on the first response when the request requested to start
 a new transaction.
      bytes transaction = 2;
      Parameters:
      value - The transaction to set.
      Returns:
      This builder for chaining.

    • clearTransaction

      public RunAggregationQueryResponse.Builder clearTransaction()
       The transaction that was started as part of this request.

 Only present on the first response when the request requested to start
 a new transaction.
      bytes transaction = 2;
      Returns:
      This builder for chaining.

    • hasReadTime

      public boolean hasReadTime()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      hasReadTime in interface RunAggregationQueryResponseOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTime in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The readTime.

    • setReadTime

      public RunAggregationQueryResponse.Builder setReadTime(com.google.protobuf.Timestamp value)
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • setReadTime

      public RunAggregationQueryResponse.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • mergeReadTime

      public RunAggregationQueryResponse.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • clearReadTime

      public RunAggregationQueryResponse.Builder clearReadTime()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • getReadTimeBuilder

      public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTimeOrBuilder in interface RunAggregationQueryResponseOrBuilder

    • hasExplainMetrics

      public boolean hasExplainMetrics()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;
      Specified by:
      hasExplainMetrics in interface RunAggregationQueryResponseOrBuilder
      Returns:
      Whether the explainMetrics field is set.

    • getExplainMetrics

      public ExplainMetrics getExplainMetrics()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;
      Specified by:
      getExplainMetrics in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The explainMetrics.

    • setExplainMetrics

      public RunAggregationQueryResponse.Builder setExplainMetrics(ExplainMetrics value)
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;

    • setExplainMetrics

      public RunAggregationQueryResponse.Builder setExplainMetrics(ExplainMetrics.Builder builderForValue)
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;

    • mergeExplainMetrics

      public RunAggregationQueryResponse.Builder mergeExplainMetrics(ExplainMetrics value)
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;

    • clearExplainMetrics

      public RunAggregationQueryResponse.Builder clearExplainMetrics()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;

    • getExplainMetricsBuilder

      public ExplainMetrics.Builder getExplainMetricsBuilder()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;

    • getExplainMetricsOrBuilder

      public ExplainMetricsOrBuilder getExplainMetricsOrBuilder()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;
      Specified by:
      getExplainMetricsOrBuilder in interface RunAggregationQueryResponseOrBuilder

    • setUnknownFields

      public final RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>

    • mergeUnknownFields

      public final RunAggregationQueryResponse.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<RunAggregationQueryResponse.Builder>