Class AggregationQuery.Aggregation.Sum.Builder (2.21.1)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AggregationQuery.Aggregation.Sum.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

build()

public AggregationQuery.Aggregation.Sum build()
Returns
Type Description
AggregationQuery.Aggregation.Sum

buildPartial()

public AggregationQuery.Aggregation.Sum buildPartial()
Returns
Type Description
AggregationQuery.Aggregation.Sum

clear()

public AggregationQuery.Aggregation.Sum.Builder clear()
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AggregationQuery.Aggregation.Sum.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AggregationQuery.Aggregation.Sum.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

clearProperty()

public AggregationQuery.Aggregation.Sum.Builder clearProperty()

The property to aggregate on.

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

Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder

clone()

public AggregationQuery.Aggregation.Sum.Builder clone()
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getProperty()

public PropertyReference getProperty()

The property to aggregate on.

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

Returns
Type Description
PropertyReference

The property.

getPropertyBuilder()

public PropertyReference.Builder getPropertyBuilder()

The property to aggregate on.

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

Returns
Type Description
PropertyReference.Builder

getPropertyOrBuilder()

public PropertyReferenceOrBuilder getPropertyOrBuilder()

The property to aggregate on.

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

Returns
Type Description
PropertyReferenceOrBuilder

hasProperty()

public boolean hasProperty()

The property to aggregate on.

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

Returns
Type Description
boolean

Whether the property field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AggregationQuery.Aggregation.Sum other)

public AggregationQuery.Aggregation.Sum.Builder mergeFrom(AggregationQuery.Aggregation.Sum other)
Parameter
Name Description
other AggregationQuery.Aggregation.Sum
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AggregationQuery.Aggregation.Sum.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AggregationQuery.Aggregation.Sum.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

mergeProperty(PropertyReference value)

public AggregationQuery.Aggregation.Sum.Builder mergeProperty(PropertyReference value)

The property to aggregate on.

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

Parameter
Name Description
value PropertyReference
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AggregationQuery.Aggregation.Sum.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AggregationQuery.Aggregation.Sum.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

setProperty(PropertyReference value)

public AggregationQuery.Aggregation.Sum.Builder setProperty(PropertyReference value)

The property to aggregate on.

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

Parameter
Name Description
value PropertyReference
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder

setProperty(PropertyReference.Builder builderForValue)

public AggregationQuery.Aggregation.Sum.Builder setProperty(PropertyReference.Builder builderForValue)

The property to aggregate on.

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

Parameter
Name Description
builderForValue PropertyReference.Builder
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AggregationQuery.Aggregation.Sum.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AggregationQuery.Aggregation.Sum.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationQuery.Aggregation.Sum.Builder
Overrides