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

Class MatchQuery.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<MatchQuery.Builder>
co.elastic.clients.elasticsearch._types.query_dsl.MatchQuery.Builder
All Implemented Interfaces:
WithJson<MatchQuery.Builder>, ObjectBuilder<MatchQuery>
Enclosing class:
MatchQuery
public static class MatchQuery.Builder extends QueryBase.AbstractBuilder<MatchQuery.Builder> implements ObjectBuilder<MatchQuery>
Builder for MatchQuery.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • field

      public final MatchQuery.Builder field(String value)
      Required - The target field

    • analyzer

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

      API name: analyzer

    • autoGenerateSynonymsPhraseQuery

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

      API name: auto_generate_synonyms_phrase_query

    • cutoffFrequency

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

    • fuzziness

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

      API name: fuzziness

    • fuzzyRewrite

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

      API name: fuzzy_rewrite

    • fuzzyTranspositions

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

      API name: fuzzy_transpositions

    • lenient

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

      API name: lenient

    • maxExpansions

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

      API name: max_expansions

    • minimumShouldMatch

      public final MatchQuery.Builder minimumShouldMatch(@Nullable String value)
      Minimum number of clauses that must match for a document to be returned.

      API name: minimum_should_match

    • operator

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

      API name: operator

    • prefixLength

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

      API name: prefix_length

    • query

      public final MatchQuery.Builder query(FieldValue value)
      Required - Text, number, boolean value or date you wish to find in the provided field.

      API name: query

    • query

      public final MatchQuery.Builder query(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)
      Required - Text, number, boolean value or date you wish to find in the provided field.

      API name: query

    • query

      public final MatchQuery.Builder query(String value)
      Required - Text, number, boolean value or date you wish to find in the provided field.

      API name: query

    • query

      public final MatchQuery.Builder query(long value)
      Required - Text, number, boolean value or date you wish to find in the provided field.

      API name: query

    • query

      public final MatchQuery.Builder query(double value)
      Required - Text, number, boolean value or date you wish to find in the provided field.

      API name: query

    • query

      public final MatchQuery.Builder query(boolean value)
      Required - Text, number, boolean value or date you wish to find in the provided field.

      API name: query

    • zeroTermsQuery

      public final MatchQuery.Builder zeroTermsQuery(@Nullable ZeroTermsQuery value)
      Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.

      API name: zero_terms_query

    • self

      protected MatchQuery.Builder self()
      Specified by:
      self in class QueryBase.AbstractBuilder<MatchQuery.Builder>

    • build

      public MatchQuery build()
      Builds a MatchQuery.
      Specified by:
      build in interface ObjectBuilder<MatchQuery>
      Throws:
      NullPointerException - if some of the required fields are null.