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

AggregateHints

class AggregateHints : AbstractOptions<AggregateHints> (source)

Hints of an aggregation.

Constructors

AggregateHints

constructor()

No hints.

Functions

with

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

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): AggregateHints

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

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

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

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

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

A copy with the option key set to value.

withForceStreamableEnabled

fun withForceStreamableEnabled(): AggregateHints

A copy that makes the backend stream the aggregation.