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

FindNearestOptions

class FindNearestOptions : AbstractOptions<FindNearestOptions> (source)

The options of a nearest-neighbour search.

Constructors

FindNearestOptions

constructor()

No options.

Functions

with

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

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

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

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

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

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

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

A copy with the option key set to value.

withDistanceField

fun withDistanceField(distanceField: Field): FindNearestOptions

fun withDistanceField(distanceField: String?): FindNearestOptions?

A copy writing the distance of each result to the field distanceField.

withLimit

fun withLimit(limit: Long): FindNearestOptions

A copy returning at most limit documents.