Package com.google.firestore.v1

Class AggregationResult.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AggregationResult.Builder>
com.google.firestore.v1.AggregationResult.Builder
All Implemented Interfaces:
AggregationResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AggregationResult
public static final class AggregationResult.Builder extends com.google.protobuf.GeneratedMessage.Builder<AggregationResult.Builder> implements AggregationResultOrBuilder
 The result of a single bucket from a Firestore aggregation query.

 The keys of `aggregate_fields` are the same for all results in an aggregation
 query, unlike document queries which can have different fields present for
 each result.
Protobuf type google.firestore.v1.AggregationResult

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<AggregationResult.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<AggregationResult.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<AggregationResult.Builder>

    • clear

      public AggregationResult.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.GeneratedMessage.Builder<AggregationResult.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.GeneratedMessage.Builder<AggregationResult.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public AggregationResult.Builder mergeFrom(AggregationResult other)

    • isInitialized

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

    • mergeFrom

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

    • getAggregateFieldsCount

      public int getAggregateFieldsCount()
      Description copied from interface: AggregationResultOrBuilder
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;
      Specified by:
      getAggregateFieldsCount in interface AggregationResultOrBuilder

    • containsAggregateFields

      public boolean containsAggregateFields(String key)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;
      Specified by:
      containsAggregateFields in interface AggregationResultOrBuilder

    • getAggregateFields

      @Deprecated public Map<String,Value> getAggregateFields()
      Deprecated.
      Use getAggregateFieldsMap() instead.
      Specified by:
      getAggregateFields in interface AggregationResultOrBuilder

    • getAggregateFieldsMap

      public Map<String,Value> getAggregateFieldsMap()
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;
      Specified by:
      getAggregateFieldsMap in interface AggregationResultOrBuilder

    • getAggregateFieldsOrDefault

      public Value getAggregateFieldsOrDefault(String key, Value defaultValue)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;
      Specified by:
      getAggregateFieldsOrDefault in interface AggregationResultOrBuilder

    • getAggregateFieldsOrThrow

      public Value getAggregateFieldsOrThrow(String key)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;
      Specified by:
      getAggregateFieldsOrThrow in interface AggregationResultOrBuilder

    • clearAggregateFields

      public AggregationResult.Builder clearAggregateFields()

    • removeAggregateFields

      public AggregationResult.Builder removeAggregateFields(String key)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;

    • getMutableAggregateFields

      @Deprecated public Map<String,Value> getMutableAggregateFields()
      Deprecated.
      Use alternate mutation accessors instead.

    • putAggregateFields

      public AggregationResult.Builder putAggregateFields(String key, Value value)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;

    • putAllAggregateFields

      public AggregationResult.Builder putAllAggregateFields(Map<String,Value> values)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;

    • putAggregateFieldsBuilderIfAbsent

      public Value.Builder putAggregateFieldsBuilderIfAbsent(String key)
       The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
      map<string, .google.firestore.v1.Value> aggregate_fields = 2;