Package org.opensearch.protobufs

Class KnnQuery

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.opensearch.protobufs.KnnQuery
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, KnnQueryOrBuilder
public final class KnnQuery extends com.google.protobuf.GeneratedMessageV3 implements KnnQueryOrBuilder
Protobuf type org.opensearch.protobufs.KnnQuery
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KnnQuery.Builder
    Protobuf type org.opensearch.protobufs.KnnQuery

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOOST_FIELD_NUMBER
     
    static final int
    EXPAND_NESTED_DOCS_FIELD_NUMBER
     
    static final int
    FIELD_FIELD_NUMBER
     
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    K_FIELD_NUMBER
     
    static final int
    MAX_DISTANCE_FIELD_NUMBER
     
    static final int
    METHOD_PARAMETERS_FIELD_NUMBER
     
    static final int
    MIN_SCORE_FIELD_NUMBER
     
    static final int
    RESCORE_FIELD_NUMBER
     
    static final int
    VECTOR_FIELD_NUMBER
     
    static final int
    X_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    float
    getBoost()
    optional float boost = 7 [json_name = "boost"];
    static KnnQuery
    getDefaultInstance()
     
    KnnQuery
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getExpandNestedDocs()
    optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
    String
    getField()
    string field = 1 [json_name = "field"];
    com.google.protobuf.ByteString
    getFieldBytes()
    string field = 1 [json_name = "field"];
    QueryContainer
    getFilter()
    optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
    QueryContainerOrBuilder
    getFilterOrBuilder()
    optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
    int
    getK()
    optional int32 k = 3 [json_name = "k"];
    float
    getMaxDistance()
    optional float max_distance = 5 [json_name = "maxDistance"];
    ObjectMap
    getMethodParameters()
    optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
    ObjectMapOrBuilder
    getMethodParametersOrBuilder()
    optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
    float
    getMinScore()
    optional float min_score = 4 [json_name = "minScore"];
    com.google.protobuf.Parser<KnnQuery>
    getParserForType()
     
    KnnQueryRescore
    getRescore()
    optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
    KnnQueryRescoreOrBuilder
    getRescoreOrBuilder()
    optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
    int
    getSerializedSize()
     
    float
    getVector(int index)
    repeated float vector = 2 [json_name = "vector"];
    int
    getVectorCount()
    repeated float vector = 2 [json_name = "vector"];
    List<Float>
    getVectorList()
    repeated float vector = 2 [json_name = "vector"];
    String
    getXName()
    optional string x_name = 8 [json_name = "xName"];
    com.google.protobuf.ByteString
    getXNameBytes()
    optional string x_name = 8 [json_name = "xName"];
    boolean
    hasBoost()
    optional float boost = 7 [json_name = "boost"];
    boolean
    hasExpandNestedDocs()
    optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
    boolean
    hasFilter()
    optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
    int
    hashCode()
     
    boolean
    hasK()
    optional int32 k = 3 [json_name = "k"];
    boolean
    hasMaxDistance()
    optional float max_distance = 5 [json_name = "maxDistance"];
    boolean
    hasMethodParameters()
    optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
    boolean
    hasMinScore()
    optional float min_score = 4 [json_name = "minScore"];
    boolean
    hasRescore()
    optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
    boolean
    hasXName()
    optional string x_name = 8 [json_name = "xName"];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KnnQuery.Builder
    newBuilder()
     
    static KnnQuery.Builder
    newBuilder(KnnQuery prototype)
     
    KnnQuery.Builder
    newBuilderForType()
     
    protected KnnQuery.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static KnnQuery
    parseDelimitedFrom(InputStream input)
     
    static KnnQuery
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnnQuery
    parseFrom(byte[] data)
     
    static KnnQuery
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnnQuery
    parseFrom(com.google.protobuf.ByteString data)
     
    static KnnQuery
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnnQuery
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KnnQuery
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnnQuery
    parseFrom(InputStream input)
     
    static KnnQuery
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnnQuery
    parseFrom(ByteBuffer data)
     
    static KnnQuery
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KnnQuery>
    parser()
     
    KnnQuery.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getField

      public String getField()
      string field = 1 [json_name = "field"];
      Specified by:
      getField in interface KnnQueryOrBuilder
      Returns:
      The field.

    • getFieldBytes

      public com.google.protobuf.ByteString getFieldBytes()
      string field = 1 [json_name = "field"];
      Specified by:
      getFieldBytes in interface KnnQueryOrBuilder
      Returns:
      The bytes for field.

    • getVectorList

      public List<Float> getVectorList()
      repeated float vector = 2 [json_name = "vector"];
      Specified by:
      getVectorList in interface KnnQueryOrBuilder
      Returns:
      A list containing the vector.

    • getVectorCount

      public int getVectorCount()
      repeated float vector = 2 [json_name = "vector"];
      Specified by:
      getVectorCount in interface KnnQueryOrBuilder
      Returns:
      The count of vector.

    • getVector

      public float getVector(int index)
      repeated float vector = 2 [json_name = "vector"];
      Specified by:
      getVector in interface KnnQueryOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The vector at the given index.

    • hasK

      public boolean hasK()
      optional int32 k = 3 [json_name = "k"];
      Specified by:
      hasK in interface KnnQueryOrBuilder
      Returns:
      Whether the k field is set.

    • getK

      public int getK()
      optional int32 k = 3 [json_name = "k"];
      Specified by:
      getK in interface KnnQueryOrBuilder
      Returns:
      The k.

    • hasMinScore

      public boolean hasMinScore()
      optional float min_score = 4 [json_name = "minScore"];
      Specified by:
      hasMinScore in interface KnnQueryOrBuilder
      Returns:
      Whether the minScore field is set.

    • getMinScore

      public float getMinScore()
      optional float min_score = 4 [json_name = "minScore"];
      Specified by:
      getMinScore in interface KnnQueryOrBuilder
      Returns:
      The minScore.

    • hasMaxDistance

      public boolean hasMaxDistance()
      optional float max_distance = 5 [json_name = "maxDistance"];
      Specified by:
      hasMaxDistance in interface KnnQueryOrBuilder
      Returns:
      Whether the maxDistance field is set.

    • getMaxDistance

      public float getMaxDistance()
      optional float max_distance = 5 [json_name = "maxDistance"];
      Specified by:
      getMaxDistance in interface KnnQueryOrBuilder
      Returns:
      The maxDistance.

    • hasFilter

      public boolean hasFilter()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
      Specified by:
      hasFilter in interface KnnQueryOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public QueryContainer getFilter()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
      Specified by:
      getFilter in interface KnnQueryOrBuilder
      Returns:
      The filter.

    • getFilterOrBuilder

      public QueryContainerOrBuilder getFilterOrBuilder()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
      Specified by:
      getFilterOrBuilder in interface KnnQueryOrBuilder

    • hasBoost

      public boolean hasBoost()
      optional float boost = 7 [json_name = "boost"];
      Specified by:
      hasBoost in interface KnnQueryOrBuilder
      Returns:
      Whether the boost field is set.

    • getBoost

      public float getBoost()
      optional float boost = 7 [json_name = "boost"];
      Specified by:
      getBoost in interface KnnQueryOrBuilder
      Returns:
      The boost.

    • hasXName

      public boolean hasXName()
      optional string x_name = 8 [json_name = "xName"];
      Specified by:
      hasXName in interface KnnQueryOrBuilder
      Returns:
      Whether the xName field is set.

    • getXName

      public String getXName()
      optional string x_name = 8 [json_name = "xName"];
      Specified by:
      getXName in interface KnnQueryOrBuilder
      Returns:
      The xName.

    • getXNameBytes

      public com.google.protobuf.ByteString getXNameBytes()
      optional string x_name = 8 [json_name = "xName"];
      Specified by:
      getXNameBytes in interface KnnQueryOrBuilder
      Returns:
      The bytes for xName.

    • hasMethodParameters

      public boolean hasMethodParameters()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
      Specified by:
      hasMethodParameters in interface KnnQueryOrBuilder
      Returns:
      Whether the methodParameters field is set.

    • getMethodParameters

      public ObjectMap getMethodParameters()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
      Specified by:
      getMethodParameters in interface KnnQueryOrBuilder
      Returns:
      The methodParameters.

    • getMethodParametersOrBuilder

      public ObjectMapOrBuilder getMethodParametersOrBuilder()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
      Specified by:
      getMethodParametersOrBuilder in interface KnnQueryOrBuilder

    • hasRescore

      public boolean hasRescore()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
      Specified by:
      hasRescore in interface KnnQueryOrBuilder
      Returns:
      Whether the rescore field is set.

    • getRescore

      public KnnQueryRescore getRescore()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
      Specified by:
      getRescore in interface KnnQueryOrBuilder
      Returns:
      The rescore.

    • getRescoreOrBuilder

      public KnnQueryRescoreOrBuilder getRescoreOrBuilder()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
      Specified by:
      getRescoreOrBuilder in interface KnnQueryOrBuilder

    • hasExpandNestedDocs

      public boolean hasExpandNestedDocs()
      optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
      Specified by:
      hasExpandNestedDocs in interface KnnQueryOrBuilder
      Returns:
      Whether the expandNestedDocs field is set.

    • getExpandNestedDocs

      public boolean getExpandNestedDocs()
      optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
      Specified by:
      getExpandNestedDocs in interface KnnQueryOrBuilder
      Returns:
      The expandNestedDocs.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static KnnQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KnnQuery parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KnnQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KnnQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KnnQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KnnQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KnnQuery parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KnnQuery parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KnnQuery parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KnnQuery parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KnnQuery parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KnnQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public KnnQuery.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static KnnQuery.Builder newBuilder()

    • newBuilder

      public static KnnQuery.Builder newBuilder(KnnQuery prototype)

    • toBuilder

      public KnnQuery.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected KnnQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static KnnQuery getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<KnnQuery> parser()

    • getParserForType

      public com.google.protobuf.Parser<KnnQuery> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public KnnQuery getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder