public interface SearchHintOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getIndexHint()
public abstract SearchHint.IndexHint getIndexHint()Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.KnnHintOrBuilder |
|
getUseIndex() (deprecated)
public abstract SearchHint.IndexHint getUseIndex()Deprecated. google.cloud.vectorsearch.v1beta.SearchHint.use_index is deprecated. See google/cloud/vectorsearch/v1beta/data_object_search_service.proto;l=142
Optional. Deprecated: Use index_hint instead.
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint |
The useIndex. |
getUseIndexOrBuilder() (deprecated)
public abstract SearchHint.IndexHintOrBuilder getUseIndexOrBuilder() Optional. Deprecated: Use index_hint instead.
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHintOrBuilder |
|
getUseKnn() (deprecated)
public abstract boolean getUseKnn()Deprecated. google.cloud.vectorsearch.v1beta.SearchHint.use_knn is deprecated. See google/cloud/vectorsearch/v1beta/data_object_search_service.proto;l=148
Optional. Deprecated: Use knn_hint instead.
If set to true, the search will use the system's default
K-Nearest Neighbor (KNN) index engine.
bool use_knn = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The useKnn. |
hasIndexHint()
public abstract boolean hasIndexHint()Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.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.v1beta.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the knnHint field is set. |
hasUseIndex() (deprecated)
public abstract boolean hasUseIndex()Deprecated. google.cloud.vectorsearch.v1beta.SearchHint.use_index is deprecated. See google/cloud/vectorsearch/v1beta/data_object_search_service.proto;l=142
Optional. Deprecated: Use index_hint instead.
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the useIndex field is set. |
hasUseKnn() (deprecated)
public abstract boolean hasUseKnn()Deprecated. google.cloud.vectorsearch.v1beta.SearchHint.use_knn is deprecated. See google/cloud/vectorsearch/v1beta/data_object_search_service.proto;l=148
Optional. Deprecated: Use knn_hint instead.
If set to true, the search will use the system's default
K-Nearest Neighbor (KNN) index engine.
bool use_knn = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the useKnn field is set. |