Package co.elastic.clients.elasticsearch._types.query_dsl

Class MatchQuery

java.lang.Object
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
co.elastic.clients.elasticsearch._types.query_dsl.MatchQuery
All Implemented Interfaces:
QueryVariant, ApiKeyQueryVariant, RoleQueryVariant, UserQueryVariant, JsonpSerializable
@JsonpDeserializable public class MatchQuery extends QueryBase implements ApiKeyQueryVariant, QueryVariant, RoleQueryVariant, UserQueryVariant
See Also:

  • Field Details

  • Method Details

    • of

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

    • _apiKeyQueryKind

      public ApiKeyQuery.Kind _apiKeyQueryKind()
      ApiKeyQuery variant kind.
      Specified by:
      _apiKeyQueryKind in interface ApiKeyQueryVariant

    • _queryKind

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

    • _roleQueryKind

      public RoleQuery.Kind _roleQueryKind()
      RoleQuery variant kind.
      Specified by:
      _roleQueryKind in interface RoleQueryVariant

    • _userQueryKind

      public UserQuery.Kind _userQueryKind()
      UserQuery variant kind.
      Specified by:
      _userQueryKind in interface UserQueryVariant

    • field

      public final String field()
      Required - The target field

    • 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

      @Deprecated @Nullable public final Double cutoffFrequency()
      Deprecated.
      7.3.0
      API name: cutoff_frequency

    • fuzziness

      @Nullable public final String fuzziness()
      Maximum edit distance allowed for matching.

      API name: fuzziness

    • fuzzyRewrite

      @Nullable public final String fuzzyRewrite()
      Method used to rewrite the query.

      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()
      Minimum number of clauses that must match for a document to be returned.

      API name: minimum_should_match

    • operator

      @Nullable public final Operator operator()
      Boolean logic used to interpret text in the query value.

      API name: operator

    • prefixLength

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

      API name: prefix_length

    • query

      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()
      Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.

      API name: zero_terms_query

    • serializeInternal

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

    • setupMatchQueryDeserializer

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