Class StructuredAggregationQuery.Aggregation.Sum (3.17.0)

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
TypeDescription
int

Static Methods

getDefaultInstance()

public static StructuredAggregationQuery.Aggregation.Sum getDefaultInstance()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StructuredAggregationQuery.Aggregation.Sum.Builder newBuilder()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum.Builder

newBuilder(StructuredAggregationQuery.Aggregation.Sum prototype)

public static StructuredAggregationQuery.Aggregation.Sum.Builder newBuilder(StructuredAggregationQuery.Aggregation.Sum prototype)
Parameter
NameDescription
prototypeStructuredAggregationQuery.Aggregation.Sum
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum.Builder

parseDelimitedFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Sum parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredAggregationQuery.Aggregation.Sum parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Sum getDefaultInstanceForType()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum

getField()

public StructuredQuery.FieldReference getField()

The field to aggregate on.

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

Returns
TypeDescription
StructuredQuery.FieldReference

The field.

getFieldOrBuilder()

public StructuredQuery.FieldReferenceOrBuilder getFieldOrBuilder()

The field to aggregate on.

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

Returns
TypeDescription
StructuredQuery.FieldReferenceOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasField()

public boolean hasField()

The field to aggregate on.

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

Returns
TypeDescription
boolean

Whether the field field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StructuredAggregationQuery.Aggregation.Sum.Builder newBuilderForType()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredAggregationQuery.Aggregation.Sum.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StructuredAggregationQuery.Aggregation.Sum.Builder toBuilder()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Sum.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException