Class QueryStringQuery
java.lang.Object
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
co.elastic.clients.elasticsearch._types.query_dsl.QueryStringQuery
- All Implemented Interfaces:
QueryVariant
,JsonpSerializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<QueryStringQuery>
Json deserializer forQueryStringQuery
-
Method Summary
Modifier and TypeMethodDescriptionQuery variant kind.final Boolean
Iftrue
, the wildcard characters*
and?
are allowed as the first character of the query string.final String
analyzer()
Analyzer used to convert text in the query string into tokens.final Boolean
Iftrue
, the query attempts to analyze wildcard terms in the query string.final Boolean
Iftrue
, match phrase queries are automatically created for multi-term synonyms.final String
Default field to search if no field is provided in the query string.final Operator
Default boolean logic used to interpret text in the query string if no operators are specified.final Boolean
Iftrue
, enable position increments in queries constructed from aquery_string
search.final Boolean
escape()
API name:escape
fields()
Array of fields to search.final String
Maximum edit distance allowed for fuzzy matching.final Integer
Maximum number of terms to which the query expands for fuzzy matching.final Integer
Number of beginning characters left unchanged for fuzzy matching.final String
Method used to rewrite the query.final Boolean
Iftrue
, edits for fuzzy matching include transpositions of two adjacent characters (for example,ab
toba
).final Boolean
lenient()
Iftrue
, format-based errors, such as providing a text value for a numeric field, are ignored.final Integer
Maximum number of automaton states required for the query.final String
Minimum number of clauses that must match for a document to be returned.static QueryStringQuery
final Double
Maximum number of positions allowed between matching tokens for phrases.final String
query()
Required - Query string you wish to parse and use for search.final String
Analyzer used to convert quoted text in the query string into tokens.final String
Suffix appended to quoted text in the query string.final String
rewrite()
Method used to rewrite the query.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Double
How to combine the queries generated from the individual search terms in the resultingdis_max
query.final String
timeZone()
Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.final TextQueryType
type()
Determines how the query matches and scores documents.Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant
_toQuery
-
Field Details
-
_DESERIALIZER
Json deserializer forQueryStringQuery
-
-
Method Details
-
of
public static QueryStringQuery of(Function<QueryStringQuery.Builder, ObjectBuilder<QueryStringQuery>> fn) -
_queryKind
Query variant kind.- Specified by:
_queryKind
in interfaceQueryVariant
-
allowLeadingWildcard
Iftrue
, the wildcard characters*
and?
are allowed as the first character of the query string.API name:
allow_leading_wildcard
-
analyzer
Analyzer used to convert text in the query string into tokens.API name:
analyzer
-
analyzeWildcard
Iftrue
, the query attempts to analyze wildcard terms in the query string.API name:
analyze_wildcard
-
autoGenerateSynonymsPhraseQuery
Iftrue
, match phrase queries are automatically created for multi-term synonyms.API name:
auto_generate_synonyms_phrase_query
-
defaultField
Default field to search if no field is provided in the query string. Supports wildcards (*
). Defaults to theindex.query.default_field
index setting, which has a default value of*
.API name:
default_field
-
defaultOperator
Default boolean logic used to interpret text in the query string if no operators are specified.API name:
default_operator
-
enablePositionIncrements
Iftrue
, enable position increments in queries constructed from aquery_string
search.API name:
enable_position_increments
-
escape
API name:escape
-
fields
Array of fields to search. Supports wildcards (*
).API name:
fields
-
fuzziness
Maximum edit distance allowed for fuzzy matching.API name:
fuzziness
-
fuzzyMaxExpansions
Maximum number of terms to which the query expands for fuzzy matching.API name:
fuzzy_max_expansions
-
fuzzyPrefixLength
Number of beginning characters left unchanged for fuzzy matching.API name:
fuzzy_prefix_length
-
fuzzyRewrite
Method used to rewrite the query.API name:
fuzzy_rewrite
-
fuzzyTranspositions
Iftrue
, edits for fuzzy matching include transpositions of two adjacent characters (for example,ab
toba
).API name:
fuzzy_transpositions
-
lenient
Iftrue
, format-based errors, such as providing a text value for a numeric field, are ignored.API name:
lenient
-
maxDeterminizedStates
Maximum number of automaton states required for the query.API name:
max_determinized_states
-
minimumShouldMatch
Minimum number of clauses that must match for a document to be returned.API name:
minimum_should_match
-
phraseSlop
Maximum number of positions allowed between matching tokens for phrases.API name:
phrase_slop
-
query
Required - Query string you wish to parse and use for search.API name:
query
-
quoteAnalyzer
Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in theanalyzer
parameter.API name:
quote_analyzer
-
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
Method used to rewrite the query.API name:
rewrite
-
tieBreaker
How to combine the queries generated from the individual search terms in the resultingdis_max
query.API name:
tie_breaker
-
timeZone
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
Determines how the query matches and scores documents.API name:
type
-
serializeInternal
- Overrides:
serializeInternal
in classQueryBase
-
setupQueryStringQueryDeserializer
protected static void setupQueryStringQueryDeserializer(ObjectDeserializer<QueryStringQuery.Builder> op)
-