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

Class MatchPhraseQuery

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

co.elastic.clients.elasticsearch._types.query_dsl.MatchPhraseQuery

All Implemented Interfaces:

QueryVariant, JsonpSerializable

@JsonpDeserializable
public class MatchPhraseQuery
extends QueryBase
implements QueryVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatchPhraseQuery.Builder	Builder for MatchPhraseQuery.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MatchPhraseQuery>	_DESERIALIZER	Json deserializer for MatchPhraseQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final String	analyzer()	Analyzer used to convert the text in the query value into tokens.
final String	field()	Required - The target field
static MatchPhraseQuery	of(Function<MatchPhraseQuery.Builder,ObjectBuilder<MatchPhraseQuery>> fn)
final String	query()	Required - Query terms that are analyzed and turned into a phrase query.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupMatchPhraseQueryDeserializer(ObjectDeserializer<MatchPhraseQuery.Builder> op)
final Integer	slop()	Maximum number of positions allowed between matching tokens.
final ZeroTermsQuery	zeroTermsQuery()	Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.

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

public static final JsonpDeserializer<MatchPhraseQuery> _DESERIALIZER

Json deserializer for MatchPhraseQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

field

public final String field()

Required - The target field

analyzer

@Nullable
public final String analyzer()

Analyzer used to convert the text in the query value into tokens.

API name: analyzer

query

public final String query()

Required - Query terms that are analyzed and turned into a phrase query.

API name: query

slop

@Nullable
public final Integer slop()

Maximum number of positions allowed between matching tokens.

API name: slop

zeroTermsQuery

@Nullable
public final ZeroTermsQuery zeroTermsQuery()

Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.

API name: zero_terms_query

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class QueryBase

setupMatchPhraseQueryDeserializer

protected static void setupMatchPhraseQueryDeserializer(ObjectDeserializer<MatchPhraseQuery.Builder> op)