Package com.google.cloud.firestore

Class VectorQueryOptions

java.lang.Object

com.google.cloud.firestore.VectorQueryOptions

public class VectorQueryOptions
extends Object

Specifies the behavior of the VectorQuery generated by a call to Query.findNearest(java.lang.String, double[], int, com.google.cloud.firestore.VectorQuery.DistanceMeasure).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VectorQueryOptions.Builder

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if this VectorQueryOptions is equal to the provided object.
FieldPath	getDistanceResultField()
Double	getDistanceThreshold()
static VectorQueryOptions.Builder	newBuilder()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getDistanceResultField

@Nullable
public FieldPath getDistanceResultField()

getDistanceThreshold

@Nullable
public Double getDistanceThreshold()

newBuilder

public static VectorQueryOptions.Builder newBuilder()

equals

public boolean equals(Object obj)

Returns true if this VectorQueryOptions is equal to the provided object.

Overrides:

equals in class Object

Parameters:

obj - The object to compare against.

Returns:

Whether this VectorQueryOptions is equal to the provided object.