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

Class SimpleQueryStringQuery

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

  • Field Details

  • Method Details

    • of

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

    • _queryKind

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

    • 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, the parser creates a match_phrase query for each multi-position token.

      API name: auto_generate_synonyms_phrase_query

    • defaultOperator

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

    • fields

      @Nonnull public final List<String> fields()
      Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.

      API name: fields

    • flags

      @Nullable public final SimpleQueryStringFlags flags()
      API name: flags

    • 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

    • 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

    • minimumShouldMatch

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

    • query

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

      API name: query

    • quoteFieldSuffix

      @Nullable public final String quoteFieldSuffix()
      Suffix appended to quoted text in the query string.

      API name: quote_field_suffix

    • serializeInternal

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

    • toBuilder

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

    • builder

      @Nonnull public static SimpleQueryStringQuery.Builder builder()

    • setupSimpleQueryStringQueryDeserializer

      protected static void setupSimpleQueryStringQueryDeserializer(ObjectDeserializer<SimpleQueryStringQuery.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class QueryBase

    • equals

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