public final class VectorQuery extends StreamableQuery<VectorQuerySnapshot>
A query that finds the documents whose vector fields are closest to a certain query vector.
Create an instance of VectorQuery
with Query#findNearest.
Methods
equals(Object obj)
public boolean equals(Object obj)
Returns true if this VectorQuery is equal to the provided object.
Parameter | |
---|---|
Name | Description |
obj |
Object The object to compare against. |
Returns | |
---|---|
Type | Description |
boolean |
Whether this VectorQuery is equal to the provided object. |
explain(ExplainOptions options)
public ApiFuture<ExplainResults<VectorQuerySnapshot>> explain(ExplainOptions options)
Plans and optionally executes this VectorQuery. Returns an ApiFuture that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any).
Parameter | |
---|---|
Name | Description |
options |
ExplainOptions |
Returns | |
---|---|
Type | Description |
ApiFuture<ExplainResults<VectorQuerySnapshot>> |
An ApiFuture that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any). |
get()
public ApiFuture<VectorQuerySnapshot> get()
Executes the query and returns the results as QuerySnapshot.
Returns | |
---|---|
Type | Description |
ApiFuture<VectorQuerySnapshot> |
An ApiFuture that will be resolved with the results of the VectorQuery. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
toRunQueryRequestBuilder(ByteString transactionId, Timestamp readTime, ExplainOptions explainOptions)
protected RunQueryRequest.Builder toRunQueryRequestBuilder(ByteString transactionId, Timestamp readTime, ExplainOptions explainOptions)
Parameters | |
---|---|
Name | Description |
transactionId |
ByteString |
readTime |
com.google.cloud.Timestamp |
explainOptions |
ExplainOptions |
Returns | |
---|---|
Type | Description |
RunQueryRequest.Builder |