Class StructuredAggregationQuery.Aggregation.Avg (3.16.3)

public static final class StructuredAggregationQuery.Aggregation.Avg extends GeneratedMessageV3 implements StructuredAggregationQuery.Aggregation.AvgOrBuilder

Average 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 NULL.

  • Always returns the result as a double.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredAggregationQuery.Aggregation.Avg
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StructuredAggregationQuery.Aggregation.Avg getDefaultInstance()

getDescriptor()

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

newBuilder()

public static StructuredAggregationQuery.Aggregation.Avg.Builder newBuilder()

newBuilder(StructuredAggregationQuery.Aggregation.Avg prototype)

public static StructuredAggregationQuery.Aggregation.Avg.Builder newBuilder(StructuredAggregationQuery.Aggregation.Avg prototype)
Parameter
NameDescription
prototypeStructuredAggregationQuery.Aggregation.Avg

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Avg getDefaultInstanceForType()

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;

getParserForType()

public Parser<StructuredAggregationQuery.Aggregation.Avg> getParserForType()
Returns
TypeDescription
Parser<Avg>
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.Avg.Builder newBuilderForType()

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredAggregationQuery.Aggregation.Avg.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public StructuredAggregationQuery.Aggregation.Avg.Builder toBuilder()

writeTo(CodedOutputStream output)

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