Class SearchHint (0.1.0)
public final class SearchHint extends GeneratedMessageV3 implements SearchHintOrBuilder
Represents a hint to the search index engine.
Protobuf type google.cloud.vectorsearch.v1beta.SearchHint
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
USE_INDEX_FIELD_NUMBER
public static final int USE_INDEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USE_KNN_FIELD_NUMBER
public static final int USE_KNN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchHint getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchHint.Builder newBuilder()
newBuilder(SearchHint prototype)
public static SearchHint.Builder newBuilder(SearchHint prototype)
public static SearchHint parseDelimitedFrom(InputStream input)
public static SearchHint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchHint parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchHint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchHint parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchHint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchHint parseFrom(CodedInputStream input)
public static SearchHint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchHint parseFrom(InputStream input)
public static SearchHint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchHint parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchHint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchHint> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchHint getDefaultInstanceForType()
getIndexTypeCase()
public SearchHint.IndexTypeCase getIndexTypeCase()
getParserForType()
public Parser<SearchHint> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUseIndex()
public SearchHint.IndexHint getUseIndex()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchHint.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchHint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchHint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
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."],[],[]]
