Package org.opensearch.protobufs

Class KnnQuery.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<KnnQuery.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>
org.opensearch.protobufs.KnnQuery.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, KnnQueryOrBuilder
Enclosing class:
KnnQuery
public static final class KnnQuery.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder> implements KnnQueryOrBuilder
Protobuf type org.opensearch.protobufs.KnnQuery

  • Method Details

    • 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.Builder<KnnQuery.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public KnnQuery.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • clearField

      public KnnQuery.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • clearOneof

      public KnnQuery.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • setRepeatedField

      public KnnQuery.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • addRepeatedField

      public KnnQuery.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • mergeFrom

      public KnnQuery.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KnnQuery.Builder>

    • mergeFrom

      public KnnQuery.Builder mergeFrom(KnnQuery other)

    • isInitialized

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

    • mergeFrom

      public KnnQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KnnQuery.Builder>
      Throws:
      IOException

    • 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.

    • setField

      public KnnQuery.Builder setField(String value)
      string field = 1 [json_name = "field"];
      Parameters:
      value - The field to set.
      Returns:
      This builder for chaining.

    • clearField

      public KnnQuery.Builder clearField()
      string field = 1 [json_name = "field"];
      Returns:
      This builder for chaining.

    • setFieldBytes

      public KnnQuery.Builder setFieldBytes(com.google.protobuf.ByteString value)
      string field = 1 [json_name = "field"];
      Parameters:
      value - The bytes for field to set.
      Returns:
      This builder for chaining.

    • 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.

    • setVector

      public KnnQuery.Builder setVector(int index, float value)
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      index - The index to set the value at.
      value - The vector to set.
      Returns:
      This builder for chaining.

    • addVector

      public KnnQuery.Builder addVector(float value)
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      value - The vector to add.
      Returns:
      This builder for chaining.

    • addAllVector

      public KnnQuery.Builder addAllVector(Iterable<? extends Float> values)
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      values - The vector to add.
      Returns:
      This builder for chaining.

    • clearVector

      public KnnQuery.Builder clearVector()
      repeated float vector = 2 [json_name = "vector"];
      Returns:
      This builder for chaining.

    • 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.

    • setK

      public KnnQuery.Builder setK(int value)
      optional int32 k = 3 [json_name = "k"];
      Parameters:
      value - The k to set.
      Returns:
      This builder for chaining.

    • clearK

      public KnnQuery.Builder clearK()
      optional int32 k = 3 [json_name = "k"];
      Returns:
      This builder for chaining.

    • 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.

    • setMinScore

      public KnnQuery.Builder setMinScore(float value)
      optional float min_score = 4 [json_name = "minScore"];
      Parameters:
      value - The minScore to set.
      Returns:
      This builder for chaining.

    • clearMinScore

      public KnnQuery.Builder clearMinScore()
      optional float min_score = 4 [json_name = "minScore"];
      Returns:
      This builder for chaining.

    • 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.

    • setMaxDistance

      public KnnQuery.Builder setMaxDistance(float value)
      optional float max_distance = 5 [json_name = "maxDistance"];
      Parameters:
      value - The maxDistance to set.
      Returns:
      This builder for chaining.

    • clearMaxDistance

      public KnnQuery.Builder clearMaxDistance()
      optional float max_distance = 5 [json_name = "maxDistance"];
      Returns:
      This builder for chaining.

    • 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.

    • setFilter

      public KnnQuery.Builder setFilter(QueryContainer value)
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];

    • setFilter

      public KnnQuery.Builder setFilter(QueryContainer.Builder builderForValue)
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];

    • mergeFilter

      public KnnQuery.Builder mergeFilter(QueryContainer value)
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];

    • clearFilter

      public KnnQuery.Builder clearFilter()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];

    • getFilterBuilder

      public QueryContainer.Builder getFilterBuilder()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "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.

    • setBoost

      public KnnQuery.Builder setBoost(float value)
      optional float boost = 7 [json_name = "boost"];
      Parameters:
      value - The boost to set.
      Returns:
      This builder for chaining.

    • clearBoost

      public KnnQuery.Builder clearBoost()
      optional float boost = 7 [json_name = "boost"];
      Returns:
      This builder for chaining.

    • 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.

    • setXName

      public KnnQuery.Builder setXName(String value)
      optional string x_name = 8 [json_name = "xName"];
      Parameters:
      value - The xName to set.
      Returns:
      This builder for chaining.

    • clearXName

      public KnnQuery.Builder clearXName()
      optional string x_name = 8 [json_name = "xName"];
      Returns:
      This builder for chaining.

    • setXNameBytes

      public KnnQuery.Builder setXNameBytes(com.google.protobuf.ByteString value)
      optional string x_name = 8 [json_name = "xName"];
      Parameters:
      value - The bytes for xName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setMethodParameters

      public KnnQuery.Builder setMethodParameters(ObjectMap value)
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];

    • setMethodParameters

      public KnnQuery.Builder setMethodParameters(ObjectMap.Builder builderForValue)
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];

    • mergeMethodParameters

      public KnnQuery.Builder mergeMethodParameters(ObjectMap value)
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];

    • clearMethodParameters

      public KnnQuery.Builder clearMethodParameters()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];

    • getMethodParametersBuilder

      public ObjectMap.Builder getMethodParametersBuilder()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "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.

    • setRescore

      public KnnQuery.Builder setRescore(KnnQueryRescore value)
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];

    • setRescore

      public KnnQuery.Builder setRescore(KnnQueryRescore.Builder builderForValue)
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];

    • mergeRescore

      public KnnQuery.Builder mergeRescore(KnnQueryRescore value)
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];

    • clearRescore

      public KnnQuery.Builder clearRescore()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];

    • getRescoreBuilder

      public KnnQueryRescore.Builder getRescoreBuilder()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "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.

    • setExpandNestedDocs

      public KnnQuery.Builder setExpandNestedDocs(boolean value)
      optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
      Parameters:
      value - The expandNestedDocs to set.
      Returns:
      This builder for chaining.

    • clearExpandNestedDocs

      public KnnQuery.Builder clearExpandNestedDocs()
      optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final KnnQuery.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>

    • mergeUnknownFields

      public final KnnQuery.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KnnQuery.Builder>