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

Class MatchPhraseQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<MatchPhraseQuery.Builder>

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

All Implemented Interfaces:

CopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>, MutableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>, ObjectBuilder<MatchPhraseQuery>

Enclosing class:

MatchPhraseQuery

public static class MatchPhraseQuery.Builder
extends QueryBase.AbstractBuilder<MatchPhraseQuery.Builder>
implements CopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>

Builder for MatchPhraseQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MatchPhraseQuery.Builder	analyzer(String value)	Analyzer used to convert the text in the query value into tokens.
MatchPhraseQuery	build()	Builds a MatchPhraseQuery.
MatchPhraseQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MatchPhraseQuery.Builder	field(String value)	Required - The target field
final MatchPhraseQuery.Builder	query(String value)	Required - Query terms that are analyzed and turned into a phrase query.
protected MatchPhraseQuery.Builder	self()
final MatchPhraseQuery.Builder	slop(Integer value)	Maximum number of positions allowed between matching tokens.
final MatchPhraseQuery.Builder	zeroTermsQuery(ZeroTermsQuery value)	API name: zero_terms_query

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

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public MatchPhraseQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<MatchPhraseQuery.Builder,MatchPhraseQuery>

Returns:

a new builder instance.

self

@Nonnull
protected MatchPhraseQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<MatchPhraseQuery.Builder>

analyzer

@Nonnull
public final MatchPhraseQuery.Builder analyzer(@Nullable
 String value)

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

API name: analyzer

field

@Nonnull
public final MatchPhraseQuery.Builder field(String value)

Required - The target field

query

@Nonnull
public final MatchPhraseQuery.Builder query(String value)

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

API name: query

slop

@Nonnull
public final MatchPhraseQuery.Builder slop(@Nullable
 Integer value)

Maximum number of positions allowed between matching tokens.

API name: slop

zeroTermsQuery

@Nonnull
public final MatchPhraseQuery.Builder zeroTermsQuery(@Nullable
 ZeroTermsQuery value)

API name: zero_terms_query

build

@Nonnull
public MatchPhraseQuery build()

Builds a MatchPhraseQuery.

Specified by:

build in interface ObjectBuilder<MatchPhraseQuery>

Throws:

NullPointerException - if some of the required fields are null.