com.google.firestore.v1

Class AggregationResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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 Summary

Modifier and Type	Method and Description
AggregationResult.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AggregationResult	build()
AggregationResult	buildPartial()
AggregationResult.Builder	clear()
AggregationResult.Builder	clearAggregateFields()
AggregationResult.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AggregationResult.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AggregationResult.Builder	clone()
boolean	containsAggregateFields(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Map<String,Value>	getAggregateFields() Deprecated.
int	getAggregateFieldsCount() The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Map<String,Value>	getAggregateFieldsMap() The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Value	getAggregateFieldsOrDefault(String key, Value defaultValue) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Value	getAggregateFieldsOrThrow(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
AggregationResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Map<String,Value>	getMutableAggregateFields() Deprecated.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
AggregationResult.Builder	mergeFrom(AggregationResult other)
AggregationResult.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AggregationResult.Builder	mergeFrom(com.google.protobuf.Message other)
AggregationResult.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AggregationResult.Builder	putAggregateFields(String key, Value value) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
AggregationResult.Builder	putAllAggregateFields(Map<String,Value> values) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
AggregationResult.Builder	removeAggregateFields(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
AggregationResult.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AggregationResult.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AggregationResult.Builder	setUnknownFields(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, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<AggregationResult.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<AggregationResult.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

public AggregationResult.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<AggregationResult.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.GeneratedMessageV3.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;

setUnknownFields

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

mergeUnknownFields

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