Class StructuredAggregationQuery.Aggregation.Avg.Builder (3.27.2)

Version 3.27.2

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class StructuredAggregationQuery.Aggregation.Avg.Builder extends GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Avg.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StructuredAggregationQuery.Aggregation.Avg.Builder

Implements

StructuredAggregationQuery.Aggregation.AvgOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Aggregation.Avg.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public StructuredAggregationQuery.Aggregation.Avg build()

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg

buildPartial()

public StructuredAggregationQuery.Aggregation.Avg buildPartial()

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg

clear()

public StructuredAggregationQuery.Aggregation.Avg.Builder clear()

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField()

public StructuredAggregationQuery.Aggregation.Avg.Builder clearField()

The field to aggregate on.

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

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

clearField(Descriptors.FieldDescriptor field)

public StructuredAggregationQuery.Aggregation.Avg.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredAggregationQuery.Aggregation.Avg.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public StructuredAggregationQuery.Aggregation.Avg.Builder clone()

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public StructuredAggregationQuery.Aggregation.Avg getDefaultInstanceForType()

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getField()

public StructuredQuery.FieldReference getField()

The field to aggregate on.

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

Returns
Type	Description
StructuredQuery.FieldReference	The field.

getFieldBuilder()

public StructuredQuery.FieldReference.Builder getFieldBuilder()

The field to aggregate on.

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

Returns
Type	Description
StructuredQuery.FieldReference.Builder

getFieldOrBuilder()

public StructuredQuery.FieldReferenceOrBuilder getFieldOrBuilder()

The field to aggregate on.

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

Returns
Type	Description
StructuredQuery.FieldReferenceOrBuilder

hasField()

public boolean hasField()

The field to aggregate on.

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

Returns
Type	Description
boolean	Whether the field field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeField(StructuredQuery.FieldReference value)

public StructuredAggregationQuery.Aggregation.Avg.Builder mergeField(StructuredQuery.FieldReference value)

The field to aggregate on.

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

Parameter
Name	Description
value	StructuredQuery.FieldReference

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

mergeFrom(StructuredAggregationQuery.Aggregation.Avg other)

public StructuredAggregationQuery.Aggregation.Avg.Builder mergeFrom(StructuredAggregationQuery.Aggregation.Avg other)

Parameter
Name	Description
other	StructuredAggregationQuery.Aggregation.Avg

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredAggregationQuery.Aggregation.Avg.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public StructuredAggregationQuery.Aggregation.Avg.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Aggregation.Avg.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(StructuredQuery.FieldReference value)

public StructuredAggregationQuery.Aggregation.Avg.Builder setField(StructuredQuery.FieldReference value)

The field to aggregate on.

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

Parameter
Name	Description
value	StructuredQuery.FieldReference

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

setField(StructuredQuery.FieldReference.Builder builderForValue)

public StructuredAggregationQuery.Aggregation.Avg.Builder setField(StructuredQuery.FieldReference.Builder builderForValue)

The field to aggregate on.

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

Parameter
Name	Description
builderForValue	StructuredQuery.FieldReference.Builder

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Aggregation.Avg.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

public StructuredAggregationQuery.Aggregation.Avg.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Aggregation.Avg.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StructuredAggregationQuery.Aggregation.Avg.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)