Class VectorQuery (3.43.1) (original) (raw)
Class VectorQuery (3.43.1)
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.
Inherited Members
Methods
equals(Object obj)
public boolean equals(Object obj)Returns true if this VectorQuery is equal to the provided object.
| Parameter | |
|---|---|
| Name | Description |
| obj | ObjectThe object to compare against. |
| Returns | |
|---|---|
| Type | Description |
| boolean | Whether this VectorQuery is equal to the provided object. |
Overrides
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). |
Overrides
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. |
Overrides
hashCode()
| Returns | |
|---|---|
| Type | Description |
| int |
Overrides
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 |
toString()
| Returns | |
|---|---|
| Type | Description |
| String |
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-18 UTC.