Package com.google.firestore.v1
Class StructuredAggregationQuery.Aggregation.Sum.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum.Builder
- All Implemented Interfaces:
StructuredAggregationQuery.Aggregation.SumOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- StructuredAggregationQuery.Aggregation.Sum
public static final class StructuredAggregationQuery.Aggregation.Sum.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
implements StructuredAggregationQuery.Aggregation.SumOrBuilder
Sum of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped. * If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns 0. * Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision. * When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.Protobuf type
google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()The field to aggregate on.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetField()The field to aggregate on.The field to aggregate on.The field to aggregate on.booleanhasField()The field to aggregate on.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanThe field to aggregate on.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) The field to aggregate on.setField(StructuredQuery.FieldReference.Builder builderForValue) The field to aggregate on.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) 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, 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<StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
setField
public StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
clearField
public StructuredAggregationQuery.Aggregation.Sum.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
clearOneof
public StructuredAggregationQuery.Aggregation.Sum.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
setRepeatedField
public StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
addRepeatedField
public StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
mergeFrom
public StructuredAggregationQuery.Aggregation.Sum.Builder mergeFrom(com.google.protobuf.Message other) - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
mergeFrom
public StructuredAggregationQuery.Aggregation.Sum.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Sum other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
mergeFrom
public StructuredAggregationQuery.Aggregation.Sum.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<StructuredAggregationQuery.Aggregation.Sum.Builder>- Throws:
IOException
-
hasField
public boolean hasField()The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1;- Specified by:
hasFieldin interfaceStructuredAggregationQuery.Aggregation.SumOrBuilder- Returns:
- Whether the field field is set.
-
getField
The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1;- Specified by:
getFieldin interfaceStructuredAggregationQuery.Aggregation.SumOrBuilder- Returns:
- The field.
-
setField
public StructuredAggregationQuery.Aggregation.Sum.Builder setField(StructuredQuery.FieldReference value) The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1; -
setField
public StructuredAggregationQuery.Aggregation.Sum.Builder setField(StructuredQuery.FieldReference.Builder builderForValue) The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1; -
mergeField
public StructuredAggregationQuery.Aggregation.Sum.Builder mergeField(StructuredQuery.FieldReference value) The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1; -
clearField
The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1; -
getFieldBuilder
The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1; -
getFieldOrBuilder
The field to aggregate on.
.google.firestore.v1.StructuredQuery.FieldReference field = 1;- Specified by:
getFieldOrBuilderin interfaceStructuredAggregationQuery.Aggregation.SumOrBuilder
-
setUnknownFields
public final StructuredAggregationQuery.Aggregation.Sum.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
-
mergeUnknownFields
public final StructuredAggregationQuery.Aggregation.Sum.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Sum.Builder>
-