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
, returnsNaN
. 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.SumImplements
AggregationQuery.Aggregation.SumOrBuilderStatic Fields
PROPERTY_FIELD_NUMBER
public static final int PROPERTY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static AggregationQuery.Aggregation.Sum getDefaultInstance()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static AggregationQuery.Aggregation.Sum.Builder newBuilder()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum.Builder |
newBuilder(AggregationQuery.Aggregation.Sum prototype)
public static AggregationQuery.Aggregation.Sum.Builder newBuilder(AggregationQuery.Aggregation.Sum prototype)
Parameter | |
---|---|
Name | Description |
prototype |
AggregationQuery.Aggregation.Sum |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum.Builder |
parseDelimitedFrom(InputStream input)
public static AggregationQuery.Aggregation.Sum parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Sum parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static AggregationQuery.Aggregation.Sum parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Sum parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static AggregationQuery.Aggregation.Sum parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Sum parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static AggregationQuery.Aggregation.Sum parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Sum parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static AggregationQuery.Aggregation.Sum parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Sum parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static AggregationQuery.Aggregation.Sum parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregationQuery.Aggregation.Sum parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<AggregationQuery.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 |
getDefaultInstanceForType()
public AggregationQuery.Aggregation.Sum getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum |
getParserForType()
public Parser<AggregationQuery.Aggregation.Sum> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Sum> |
getProperty()
public PropertyReference getProperty()
The property to aggregate on.
.google.datastore.v1.PropertyReference property = 1;
Returns | |
---|---|
Type | Description |
PropertyReference |
The property. |
getPropertyOrBuilder()
public PropertyReferenceOrBuilder getPropertyOrBuilder()
The property to aggregate on.
.google.datastore.v1.PropertyReference property = 1;
Returns | |
---|---|
Type | Description |
PropertyReferenceOrBuilder |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public AggregationQuery.Aggregation.Sum.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregationQuery.Aggregation.Sum.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public AggregationQuery.Aggregation.Sum.Builder toBuilder()
Returns | |
---|---|
Type | Description |
AggregationQuery.Aggregation.Sum.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |