Package org.opensearch.client.opensearch._types.query_dsl

Class MatchQuery

java.lang.Object
org.opensearch.client.opensearch._types.query_dsl.QueryBase
org.opensearch.client.opensearch._types.query_dsl.MatchQuery
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<MatchQuery.Builder,MatchQuery>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class MatchQuery extends QueryBase implements QueryVariant, ToCopyableBuilder<MatchQuery.Builder,MatchQuery>

  • Field Details

  • Method Details

    • of

      public static MatchQuery of(Function<MatchQuery.Builder,ObjectBuilder<MatchQuery>> fn)

    • _queryKind

      public Query.Kind _queryKind()
      Query variant kind.
      Specified by:
      _queryKind in interface QueryVariant

    • analyzer

      @Nullable public final String analyzer()
      Analyzer used to convert the text in the query value into tokens.

      API name: analyzer

    • autoGenerateSynonymsPhraseQuery

      @Nullable public final Boolean autoGenerateSynonymsPhraseQuery()
      If true, match phrase queries are automatically created for multi-term synonyms.

      API name: auto_generate_synonyms_phrase_query

    • cutoffFrequency

      @Nullable public final Float cutoffFrequency()
      API name: cutoff_frequency

    • field

      @Nonnull public final String field()
      Required - The target field

    • fuzziness

      @Nullable public final String fuzziness()
      API name: fuzziness

    • fuzzyRewrite

      @Nullable public final String fuzzyRewrite()
      API name: fuzzy_rewrite

    • fuzzyTranspositions

      @Nullable public final Boolean fuzzyTranspositions()
      If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).

      API name: fuzzy_transpositions

    • lenient

      @Nullable public final Boolean lenient()
      If true, format-based errors, such as providing a text query value for a numeric field, are ignored.

      API name: lenient

    • maxExpansions

      @Nullable public final Integer maxExpansions()
      Maximum number of terms to which the query will expand.

      API name: max_expansions

    • minimumShouldMatch

      @Nullable public final String minimumShouldMatch()
      API name: minimum_should_match

    • operator

      @Nullable public final Operator operator()
      API name: operator

    • prefixLength

      @Nullable public final Integer prefixLength()
      Number of beginning characters left unchanged for fuzzy matching.

      API name: prefix_length

    • query

      @Nonnull public final FieldValue query()
      Required - Text, number, Boolean value or date you wish to find in the provided field.

      API name: query

    • zeroTermsQuery

      @Nullable public final ZeroTermsQuery zeroTermsQuery()
      API name: zero_terms_query

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class QueryBase

    • toBuilder

      @Nonnull public MatchQuery.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MatchQuery.Builder,MatchQuery>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static MatchQuery.Builder builder()

    • setupMatchQueryDeserializer

      protected static void setupMatchQueryDeserializer(ObjectDeserializer<MatchQuery.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class QueryBase

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class QueryBase