java.lang.Object
- org.opensearch.client.opensearch._types.query_dsl.QueryBase
- - org.opensearch.client.opensearch._types.query_dsl.QueryStringQuery

All Implemented Interfaces:: JsonpSerializable, QueryVariant

@JsonpDeserializable
public class QueryStringQuery
extends QueryBase
implements QueryVariant

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class QueryStringQuery.Builder
Builder for QueryStringQuery.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
  QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static JsonpDeserializer<QueryStringQuery> _DESERIALIZER
Json deserializer for QueryStringQuery

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Query.Kind`	`_queryKind()`	Query variant kind.
`java.lang.Boolean`	`allowLeadingWildcard()`	API name: `allow_leading_wildcard`
`java.lang.String`	`analyzer()`	API name: `analyzer`
`java.lang.Boolean`	`analyzeWildcard()`	API name: `analyze_wildcard`
`java.lang.Boolean`	`autoGenerateSynonymsPhraseQuery()`	API name: `auto_generate_synonyms_phrase_query`
`java.lang.String`	`defaultField()`	API name: `default_field`
`Operator`	`defaultOperator()`	API name: `default_operator`
`java.lang.Boolean`	`enablePositionIncrements()`	API name: `enable_position_increments`
`java.lang.Boolean`	`escape()`	API name: `escape`
`java.util.List<java.lang.String>`	`fields()`	API name: `fields`
`java.lang.String`	`fuzziness()`	API name: `fuzziness`
`java.lang.Integer`	`fuzzyMaxExpansions()`	API name: `fuzzy_max_expansions`
`java.lang.Integer`	`fuzzyPrefixLength()`	API name: `fuzzy_prefix_length`
`java.lang.String`	`fuzzyRewrite()`	API name: `fuzzy_rewrite`
`java.lang.Boolean`	`fuzzyTranspositions()`	API name: `fuzzy_transpositions`
`java.lang.Boolean`	`lenient()`	API name: `lenient`
`java.lang.Integer`	`maxDeterminizedStates()`	API name: `max_determinized_states`
`java.lang.String`	`minimumShouldMatch()`	API name: `minimum_should_match`
`static QueryStringQuery`	`of(java.util.function.Function<QueryStringQuery.Builder,ObjectBuilder<QueryStringQuery>> fn)`
`java.lang.Double`	`phraseSlop()`	API name: `phrase_slop`
`java.lang.String`	`query()`	Required - API name: `query`
`java.lang.String`	`quoteAnalyzer()`	API name: `quote_analyzer`
`java.lang.String`	`quoteFieldSuffix()`	API name: `quote_field_suffix`
`java.lang.String`	`rewrite()`	API name: `rewrite`
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupQueryStringQueryDeserializer(ObjectDeserializer<QueryStringQuery.Builder> op)`
`java.lang.Double`	`tieBreaker()`	API name: `tie_breaker`
`java.lang.String`	`timeZone()`	API name: `time_zone`
`TextQueryType`	`type()`	API name: `type`

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant
_toQuery

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<QueryStringQuery> _DESERIALIZER

Json deserializer for QueryStringQuery

Method Detail

of

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

_queryKind
```
public Query.Kind _queryKind()
```
Query variant kind.

Specified by:

_queryKind in interface QueryVariant

allowLeadingWildcard

@Nullable
public final java.lang.Boolean allowLeadingWildcard()

API name: allow_leading_wildcard

analyzer

@Nullable
public final java.lang.String analyzer()

API name: analyzer

analyzeWildcard

@Nullable
public final java.lang.Boolean analyzeWildcard()

API name: analyze_wildcard

autoGenerateSynonymsPhraseQuery

@Nullable
public final java.lang.Boolean autoGenerateSynonymsPhraseQuery()

API name: auto_generate_synonyms_phrase_query

defaultField

@Nullable
public final java.lang.String defaultField()

API name: default_field

defaultOperator

@Nullable
public final Operator defaultOperator()

API name: default_operator

enablePositionIncrements

@Nullable
public final java.lang.Boolean enablePositionIncrements()

API name: enable_position_increments

escape

@Nullable
public final java.lang.Boolean escape()

API name: escape

fields

public final java.util.List<java.lang.String> fields()

API name: fields

fuzziness

@Nullable
public final java.lang.String fuzziness()

API name: fuzziness

fuzzyMaxExpansions

@Nullable
public final java.lang.Integer fuzzyMaxExpansions()

API name: fuzzy_max_expansions

fuzzyPrefixLength

@Nullable
public final java.lang.Integer fuzzyPrefixLength()

API name: fuzzy_prefix_length

fuzzyRewrite

@Nullable
public final java.lang.String fuzzyRewrite()

API name: fuzzy_rewrite

fuzzyTranspositions

@Nullable
public final java.lang.Boolean fuzzyTranspositions()

API name: fuzzy_transpositions

lenient

@Nullable
public final java.lang.Boolean lenient()

API name: lenient

maxDeterminizedStates

@Nullable
public final java.lang.Integer maxDeterminizedStates()

API name: max_determinized_states

minimumShouldMatch

@Nullable
public final java.lang.String minimumShouldMatch()

API name: minimum_should_match

phraseSlop

@Nullable
public final java.lang.Double phraseSlop()

API name: phrase_slop

query
```
public final java.lang.String query()
```
Required - API name: query

quoteAnalyzer

@Nullable
public final java.lang.String quoteAnalyzer()

API name: quote_analyzer

quoteFieldSuffix

@Nullable
public final java.lang.String quoteFieldSuffix()

API name: quote_field_suffix

rewrite

@Nullable
public final java.lang.String rewrite()

API name: rewrite

tieBreaker

@Nullable
public final java.lang.Double tieBreaker()

API name: tie_breaker

timeZone

@Nullable
public final java.lang.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

setupQueryStringQueryDeserializer

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

Class QueryStringQuery

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

Field Summary