public static final class SearchHint.Builder extends GeneratedMessage.Builder<SearchHint.Builder> implements SearchHintOrBuilderRepresents a hint to the search index engine.
Protobuf type google.cloud.vectorsearch.v1beta.SearchHint
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchHint.BuilderImplements
SearchHintOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchHint build()| Returns | |
|---|---|
| Type | Description |
SearchHint |
|
buildPartial()
public SearchHint buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchHint |
|
clear()
public SearchHint.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
clearIndexHint()
public SearchHint.Builder clearIndexHint()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.Builder |
|
clearIndexType()
public SearchHint.Builder clearIndexType()| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
clearKnnHint()
public SearchHint.Builder clearKnnHint()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.Builder |
|
clearUseIndex() (deprecated)
public SearchHint.Builder clearUseIndex() 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.Builder |
|
clearUseKnn() (deprecated)
public SearchHint.Builder clearUseKnn()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 |
SearchHint.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public SearchHint getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchHint |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIndexHint()
public 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. |
getIndexHintBuilder()
public SearchHint.IndexHint.Builder getIndexHintBuilder()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.Builder |
|
getIndexHintOrBuilder()
public 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 SearchHint.IndexTypeCase getIndexTypeCase()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexTypeCase |
|
getKnnHint()
public 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. |
getKnnHintBuilder()
public SearchHint.KnnHint.Builder getKnnHintBuilder()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.Builder |
|
getKnnHintOrBuilder()
public 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 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. |
getUseIndexBuilder() (deprecated)
public SearchHint.IndexHint.Builder getUseIndexBuilder() 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.Builder |
|
getUseIndexOrBuilder() (deprecated)
public 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchHint other)
public SearchHint.Builder mergeFrom(SearchHint other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchHint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchHint.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
mergeIndexHint(SearchHint.IndexHint value)
public SearchHint.Builder mergeIndexHint(SearchHint.IndexHint value)Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.IndexHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
mergeKnnHint(SearchHint.KnnHint value)
public SearchHint.Builder mergeKnnHint(SearchHint.KnnHint value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.KnnHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
mergeUseIndex(SearchHint.IndexHint value) (deprecated)
public SearchHint.Builder mergeUseIndex(SearchHint.IndexHint value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.IndexHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setIndexHint(SearchHint.IndexHint value)
public SearchHint.Builder setIndexHint(SearchHint.IndexHint value)Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.IndexHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setIndexHint(SearchHint.IndexHint.Builder builderForValue)
public SearchHint.Builder setIndexHint(SearchHint.IndexHint.Builder builderForValue)Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchHint.IndexHint.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setKnnHint(SearchHint.KnnHint value)
public SearchHint.Builder setKnnHint(SearchHint.KnnHint value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.KnnHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setKnnHint(SearchHint.KnnHint.Builder builderForValue)
public SearchHint.Builder setKnnHint(SearchHint.KnnHint.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchHint.KnnHint.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setUseIndex(SearchHint.IndexHint value) (deprecated)
public SearchHint.Builder setUseIndex(SearchHint.IndexHint value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.IndexHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setUseIndex(SearchHint.IndexHint.Builder builderForValue) (deprecated)
public SearchHint.Builder setUseIndex(SearchHint.IndexHint.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchHint.IndexHint.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
|
setUseKnn(boolean value) (deprecated)
public SearchHint.Builder setUseKnn(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useKnn to set. |
| Returns | |
|---|---|
| Type | Description |
SearchHint.Builder |
This builder for chaining. |