Interface SearchHintOrBuilder (0.8.0)

0.8.0 (latest) 0.6.0 0.4.0 0.3.0 0.1.0

public interface SearchHintOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIndexHint()

public abstract SearchHint.IndexHint getIndexHint()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.IndexHint	The indexHint.

getIndexHintOrBuilder()

public abstract SearchHint.IndexHintOrBuilder getIndexHintOrBuilder()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.IndexHintOrBuilder

getIndexTypeCase()

public abstract SearchHint.IndexTypeCase getIndexTypeCase()

Returns
Type	Description
SearchHint.IndexTypeCase

getKnnHint()

public abstract SearchHint.KnnHint getKnnHint()

Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

.google.cloud.vectorsearch.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.KnnHint	The knnHint.

getKnnHintOrBuilder()

public abstract SearchHint.KnnHintOrBuilder getKnnHintOrBuilder()

Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

.google.cloud.vectorsearch.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.KnnHintOrBuilder

hasIndexHint()

public abstract boolean hasIndexHint()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the indexHint field is set.

hasKnnHint()

public abstract boolean hasKnnHint()

Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

.google.cloud.vectorsearch.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the knnHint field is set.