public static final class SearchHint.Builder extends GeneratedMessage.Builder<SearchHint.Builder> implements SearchHintOrBuilder
Represents a hint to the search index engine.
Protobuf type google.cloud.vectorsearch.v1.SearchHint
Inherited Members
com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
build()
public SearchHint build()
buildPartial()
public SearchHint buildPartial()
clear()
public SearchHint.Builder clear()
Overrides
clearIndexHint()
public SearchHint.Builder clearIndexHint()
Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
clearIndexType()
public SearchHint.Builder clearIndexType()
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public SearchHint getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getIndexHint()
public 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];
getIndexHintBuilder()
public SearchHint.IndexHint.Builder getIndexHintBuilder()
Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
getIndexHintOrBuilder()
public 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];
getIndexTypeCase()
public SearchHint.IndexTypeCase getIndexTypeCase()
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
hasIndexHint()
public 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 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.
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SearchHint other)
public SearchHint.Builder mergeFrom(SearchHint other)
public SearchHint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SearchHint.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeIndexHint(SearchHint.IndexHint value)
public SearchHint.Builder mergeIndexHint(SearchHint.IndexHint value)
Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
setIndexHint(SearchHint.IndexHint value)
public SearchHint.Builder setIndexHint(SearchHint.IndexHint value)
Optional. Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
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.v1.SearchHint.IndexHint index_hint = 4 [(.google.api.field_behavior) = OPTIONAL];
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
