Class AggregationQuery.Aggregation.Sum (2.17.6)

public static final class AggregationQuery.Aggregation.Sum extends GeneratedMessageV3 implements AggregationQuery.Aggregation.SumOrBuilder

Sum of the values of the requested property.

  • 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.datastore.v1.AggregationQuery.Aggregation.Sum

Inheritance

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

Static Fields

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(AggregationQuery.Aggregation.Sum prototype)

public static AggregationQuery.Aggregation.Sum.Builder newBuilder(AggregationQuery.Aggregation.Sum prototype)
Parameter
NameDescription
prototypeAggregationQuery.Aggregation.Sum
Returns
TypeDescription
AggregationQuery.Aggregation.Sum.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<AggregationQuery.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 AggregationQuery.Aggregation.Sum getDefaultInstanceForType()
Returns
TypeDescription
AggregationQuery.Aggregation.Sum

getParserForType()

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

getProperty()

public PropertyReference getProperty()

The property to aggregate on.

.google.datastore.v1.PropertyReference property = 1;

Returns
TypeDescription
PropertyReference

The property.

getPropertyOrBuilder()

public PropertyReferenceOrBuilder getPropertyOrBuilder()

The property to aggregate on.

.google.datastore.v1.PropertyReference property = 1;

Returns
TypeDescription
PropertyReferenceOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasProperty()

public boolean hasProperty()

The property to aggregate on.

.google.datastore.v1.PropertyReference property = 1;

Returns
TypeDescription
boolean

Whether the property 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 AggregationQuery.Aggregation.Sum.Builder newBuilderForType()
Returns
TypeDescription
AggregationQuery.Aggregation.Sum.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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