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

Class QueryStringQuery

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

  • Field Details

  • Method Details

    • of

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

    • _queryKind

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

    • allowLeadingWildcard

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

      API name: allow_leading_wildcard

    • analyzeWildcard

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

      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      Analyzer used to convert text in the query string 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

    • defaultField

      @Nullable public final String defaultField()
      API name: default_field

    • defaultOperator

      @Nullable public final Operator defaultOperator()
      API name: default_operator

    • enablePositionIncrements

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

      API name: enable_position_increments

    • escape

      @Nullable public final Boolean escape()
      API name: escape

    • fields

      @Nonnull public final List<String> fields()
      Array of fields to search. Supports wildcards (*).

      API name: fields

    • fuzziness

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

    • fuzzyMaxExpansions

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

      API name: fuzzy_max_expansions

    • fuzzyPrefixLength

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

      API name: fuzzy_prefix_length

    • 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 value for a numeric field, are ignored.

      API name: lenient

    • maxDeterminizedStates

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

      API name: max_determinized_states

    • minimumShouldMatch

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

    • phraseSlop

      @Nullable public final Integer phraseSlop()
      Maximum number of positions allowed between matching tokens for phrases.

      API name: phrase_slop

    • query

      @Nonnull public final String query()
      Required - Query string you wish to parse and use for search.

      API name: query

    • quoteAnalyzer

      @Nullable public final String quoteAnalyzer()
      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

      @Nullable public final String quoteFieldSuffix()
      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

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

    • tieBreaker

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

      API name: tie_breaker

    • timeZone

      @Nullable public final String timeZone()
      API name: time_zone

    • type

      @Nullable public final TextQueryType type()
      API name: type

    • serializeInternal

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

    • toBuilder

      @Nonnull public QueryStringQuery.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<QueryStringQuery.Builder,QueryStringQuery>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static QueryStringQuery.Builder builder()

    • setupQueryStringQueryDeserializer

      protected static void setupQueryStringQueryDeserializer(ObjectDeserializer<QueryStringQuery.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class QueryBase

    • equals

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