Class SearchHint.KnnHint (0.8.0)

public static final class SearchHint.KnnHint extends GeneratedMessage implements SearchHint.KnnHintOrBuilder

KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.

Protobuf type google.cloud.vectorsearch.v1beta.SearchHint.KnnHint

Static Methods

getDefaultInstance()

public static SearchHint.KnnHint getDefaultInstance()
Returns
Type Description
SearchHint.KnnHint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchHint.KnnHint.Builder newBuilder()
Returns
Type Description
SearchHint.KnnHint.Builder

newBuilder(SearchHint.KnnHint prototype)

public static SearchHint.KnnHint.Builder newBuilder(SearchHint.KnnHint prototype)
Parameter
Name Description
prototype SearchHint.KnnHint
Returns
Type Description
SearchHint.KnnHint.Builder

parseDelimitedFrom(InputStream input)

public static SearchHint.KnnHint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchHint.KnnHint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchHint.KnnHint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchHint.KnnHint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchHint.KnnHint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchHint.KnnHint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchHint.KnnHint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchHint.KnnHint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchHint.KnnHint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchHint.KnnHint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchHint.KnnHint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchHint.KnnHint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchHint.KnnHint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchHint.KnnHint> parser()
Returns
Type Description
Parser<KnnHint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchHint.KnnHint getDefaultInstanceForType()
Returns
Type Description
SearchHint.KnnHint

getParserForType()

public Parser<SearchHint.KnnHint> getParserForType()
Returns
Type Description
Parser<KnnHint>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchHint.KnnHint.Builder newBuilderForType()
Returns
Type Description
SearchHint.KnnHint.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchHint.KnnHint.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchHint.KnnHint.Builder
Overrides

toBuilder()

public SearchHint.KnnHint.Builder toBuilder()
Returns
Type Description
SearchHint.KnnHint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException