public final class SearchHint extends GeneratedMessage implements SearchHintOrBuilder
Represents a hint to the search index engine.
Protobuf type google.cloud.vectorsearch.v1beta.SearchHint
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
INDEX_HINT_FIELD_NUMBER
public static final int INDEX_HINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KNN_HINT_FIELD_NUMBER
public static final int KNN_HINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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()
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];
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];
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.v1beta.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.v1beta.SearchHint.KnnHint knn_hint = 3 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<SearchHint> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchHint.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SearchHint.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public SearchHint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
