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

Class QueryStringQuery.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowLeadingWildcard

      public final QueryStringQuery.Builder allowLeadingWildcard(@Nullable Boolean value)
      If true, the wildcard characters * and ? are allowed as the first character of the query string.

      API name: allow_leading_wildcard

    • analyzer

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

      API name: analyzer

    • analyzeWildcard

      public final QueryStringQuery.Builder analyzeWildcard(@Nullable Boolean value)
      If true, the query attempts to analyze wildcard terms in the query string.

      API name: analyze_wildcard

    • autoGenerateSynonymsPhraseQuery

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

      API name: auto_generate_synonyms_phrase_query

    • defaultField

      public final QueryStringQuery.Builder defaultField(@Nullable String value)
      Default field to search if no field is provided in the query string. Supports wildcards (*). Defaults to the index.query.default_field index setting, which has a default value of *.

      API name: default_field

    • defaultOperator

      public final QueryStringQuery.Builder defaultOperator(@Nullable Operator value)
      Default boolean logic used to interpret text in the query string if no operators are specified.

      API name: default_operator

    • enablePositionIncrements

      public final QueryStringQuery.Builder enablePositionIncrements(@Nullable Boolean value)
      If true, enable position increments in queries constructed from a query_string search.

      API name: enable_position_increments

    • escape

      public final QueryStringQuery.Builder escape(@Nullable Boolean value)
      API name: escape

    • fields

      public final QueryStringQuery.Builder fields(List<String> list)
      Array of fields to search. Supports wildcards (*).

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final QueryStringQuery.Builder fields(String value, String... values)
      Array of fields to search. Supports wildcards (*).

      API name: fields

      Adds one or more values to fields.

    • fuzziness

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

      API name: fuzziness

    • fuzzyMaxExpansions

      public final QueryStringQuery.Builder fuzzyMaxExpansions(@Nullable Integer value)
      Maximum number of terms to which the query expands for fuzzy matching.

      API name: fuzzy_max_expansions

    • fuzzyPrefixLength

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

      API name: fuzzy_prefix_length

    • fuzzyRewrite

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

      API name: fuzzy_rewrite

    • fuzzyTranspositions

      public final QueryStringQuery.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 QueryStringQuery.Builder lenient(@Nullable Boolean value)
      If true, format-based errors, such as providing a text value for a numeric field, are ignored.

      API name: lenient

    • maxDeterminizedStates

      public final QueryStringQuery.Builder maxDeterminizedStates(@Nullable Integer value)
      Maximum number of automaton states required for the query.

      API name: max_determinized_states

    • minimumShouldMatch

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

      API name: minimum_should_match

    • phraseSlop

      public final QueryStringQuery.Builder phraseSlop(@Nullable Double value)
      Maximum number of positions allowed between matching tokens for phrases.

      API name: phrase_slop

    • query

      public final QueryStringQuery.Builder query(String value)
      Required - Query string you wish to parse and use for search.

      API name: query

    • quoteAnalyzer

      public final QueryStringQuery.Builder quoteAnalyzer(@Nullable String value)
      Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the analyzer parameter.

      API name: quote_analyzer

    • quoteFieldSuffix

      public final QueryStringQuery.Builder quoteFieldSuffix(@Nullable String value)
      Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.

      API name: quote_field_suffix

    • rewrite

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

      API name: rewrite

    • tieBreaker

      public final QueryStringQuery.Builder tieBreaker(@Nullable Double value)
      How to combine the queries generated from the individual search terms in the resulting dis_max query.

      API name: tie_breaker

    • timeZone

      public final QueryStringQuery.Builder timeZone(@Nullable String value)
      Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.

      API name: time_zone

    • type

      public final QueryStringQuery.Builder type(@Nullable TextQueryType value)
      Determines how the query matches and scores documents.

      API name: type

    • self

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

    • build

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