firebase-firestore/com.google.firebase.firestore.pipeline/AggregateOptions

AggregateOptions

class AggregateOptions : AbstractOptions<AggregateOptions> (source)

The options of an aggregation.

Constructors

AggregateOptions

constructor()

No options.

Functions

with

fun with(key: String, value: Field): AggregateOptions

A copy with the option key set to a reference to the field value. The JS SDK sends a field reference only as a nearest-neighbour search's distance field or an unnest's index field; on JS and wasmJs any other fails the execution.

fun with(key: String, value: RawOptions): AggregateOptions

A copy with the option key set to the options value.

fun with(key: String, value: Boolean): AggregateOptions

fun with(key: String, value: Double): AggregateOptions

fun with(key: String, value: Long): AggregateOptions

fun with(key: String, value: String): AggregateOptions

A copy with the option key set to value.

withHints

fun withHints(hints: AggregateHints): AggregateOptions

A copy with the hints added.