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

Class MatchPhraseQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

org.opensearch.client.opensearch._types.query_dsl.MatchPhraseQuery

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MatchPhraseQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>

Nested Class Summary

Nested Classes

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

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 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.
static MatchPhraseQuery.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - The target field
int	hashCode()
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.
MatchPhraseQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final ZeroTermsQuery	zeroTermsQuery()	API name: zero_terms_query

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

toQuery

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

analyzer

@Nullable
public final String analyzer()

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

API name: analyzer

field

@Nonnull
public final String field()

Required - The target field

query

@Nonnull
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()

API name: zero_terms_query

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public MatchPhraseQuery.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<MatchPhraseQuery.Builder,MatchPhraseQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static MatchPhraseQuery.Builder builder()

setupMatchPhraseQueryDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase