Class SearchHint.Builder (0.1.0)
public static final class SearchHint.Builder extends GeneratedMessageV3.Builder<SearchHint.Builder> implements SearchHintOrBuilder
Represents a hint to the search index engine.
Protobuf type google.cloud.vectorsearch.v1beta.SearchHint
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchHint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public SearchHint build()
buildPartial()
public SearchHint buildPartial()
clear()
public SearchHint.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public SearchHint.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearIndexType()
public SearchHint.Builder clearIndexType()
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchHint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearUseIndex()
public SearchHint.Builder clearUseIndex()
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
clearUseKnn()
public SearchHint.Builder clearUseKnn()
If set to true, the search will use the system's default
K-Nearest Neighbor (KNN) index engine.
bool use_knn = 2;
clone()
public SearchHint.Builder clone()
Overrides
getDefaultInstanceForType()
public SearchHint getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getIndexTypeCase()
public SearchHint.IndexTypeCase getIndexTypeCase()
getUseIndex()
public SearchHint.IndexHint getUseIndex()
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
getUseIndexBuilder()
public SearchHint.IndexHint.Builder getUseIndexBuilder()
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
getUseIndexOrBuilder()
public SearchHint.IndexHintOrBuilder getUseIndexOrBuilder()
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
getUseKnn()
public boolean getUseKnn()
If set to true, the search will use the system's default
K-Nearest Neighbor (KNN) index engine.
bool use_knn = 2;
| Returns |
| Type |
Description |
boolean |
The useKnn.
|
hasUseIndex()
public boolean hasUseIndex()
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
| Returns |
| Type |
Description |
boolean |
Whether the useIndex field is set.
|
hasUseKnn()
public boolean hasUseKnn()
If set to true, the search will use the system's default
K-Nearest Neighbor (KNN) index engine.
bool use_knn = 2;
| Returns |
| Type |
Description |
boolean |
Whether the useKnn field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.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
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchHint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
mergeUseIndex(SearchHint.IndexHint value)
public SearchHint.Builder mergeUseIndex(SearchHint.IndexHint value)
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
setField(Descriptors.FieldDescriptor field, Object value)
public SearchHint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchHint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchHint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
setUseIndex(SearchHint.IndexHint value)
public SearchHint.Builder setUseIndex(SearchHint.IndexHint value)
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
setUseIndex(SearchHint.IndexHint.Builder builderForValue)
public SearchHint.Builder setUseIndex(SearchHint.IndexHint.Builder builderForValue)
Specifies that the search should use a particular index.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1;
setUseKnn(boolean value)
public SearchHint.Builder setUseKnn(boolean value)
If set to true, the search will use the system's default
K-Nearest Neighbor (KNN) index engine.
bool use_knn = 2;
| Parameter |
| Name |
Description |
value |
boolean
The useKnn to set.
|
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 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
