Class StructuredAggregationQuery.Aggregation.Sum (3.21.4)

public static final class StructuredAggregationQuery.Aggregation.Sum extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredAggregationQuery.Aggregation.Sum

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StructuredAggregationQuery.Aggregation.Sum getDefaultInstance()
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StructuredAggregationQuery.Aggregation.Sum.Builder newBuilder()
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum.Builder

newBuilder(StructuredAggregationQuery.Aggregation.Sum prototype)

public static StructuredAggregationQuery.Aggregation.Sum.Builder newBuilder(StructuredAggregationQuery.Aggregation.Sum prototype)
Parameter
Name Description
prototype StructuredAggregationQuery.Aggregation.Sum
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum.Builder

parseDelimitedFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Sum parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StructuredAggregationQuery.Aggregation.Sum> parser()
Returns
Type Description
Parser<Sum>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Sum getDefaultInstanceForType()
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum

getField()

public StructuredQuery.FieldReference getField()

The field to aggregate on.

.google.firestore.v1.StructuredQuery.FieldReference field = 1;

Returns
Type Description
StructuredQuery.FieldReference

The field.

getFieldOrBuilder()

public StructuredQuery.FieldReferenceOrBuilder getFieldOrBuilder()

The field to aggregate on.

.google.firestore.v1.StructuredQuery.FieldReference field = 1;

Returns
Type Description
StructuredQuery.FieldReferenceOrBuilder

getParserForType()

public Parser<StructuredAggregationQuery.Aggregation.Sum> getParserForType()
Returns
Type Description
Parser<Sum>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasField()

public boolean hasField()

The field to aggregate on.

.google.firestore.v1.StructuredQuery.FieldReference field = 1;

Returns
Type Description
boolean

Whether the field field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StructuredAggregationQuery.Aggregation.Sum.Builder newBuilderForType()
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredAggregationQuery.Aggregation.Sum.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StructuredAggregationQuery.Aggregation.Sum.Builder toBuilder()
Returns
Type Description
StructuredAggregationQuery.Aggregation.Sum.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException