Cloud Firestore V1 Client - Class Avg (1.54.3)

Version latest

• 1.54.3 (latest)
• 1.54.2
• 1.53.1
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.1
• 1.47.3
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class Avg.

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.

Generated from protobuf message google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredAggregationQuery \ Aggregation

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ field	Google\Cloud\Firestore\V1\StructuredQuery\FieldReference The field to aggregate on.

getField

The field to aggregate on.

Returns
Type	Description
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference|null

hasField

clearField

setField

The field to aggregate on.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1\StructuredQuery\FieldReference

Returns
Type	Description
$this