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

Class MatchPhrasePrefixQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.MatchPhrasePrefixQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

MatchPhrasePrefixQuery

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

Builder for MatchPhrasePrefixQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MatchPhrasePrefixQuery.Builder	analyzer(String value)	Analyzer used to convert text in the query value into tokens.
MatchPhrasePrefixQuery	build()	Builds a MatchPhrasePrefixQuery.
MatchPhrasePrefixQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MatchPhrasePrefixQuery.Builder	field(String value)	Required - The target field
final MatchPhrasePrefixQuery.Builder	maxExpansions(Integer value)	Maximum number of terms to which the last provided term of the query value will expand.
final MatchPhrasePrefixQuery.Builder	query(String value)	Required - Text you wish to find in the provided field.
protected MatchPhrasePrefixQuery.Builder	self()
final MatchPhrasePrefixQuery.Builder	slop(Integer value)	Maximum number of positions allowed between matching tokens.
final MatchPhrasePrefixQuery.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 MatchPhrasePrefixQuery.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<MatchPhrasePrefixQuery.Builder,MatchPhrasePrefixQuery>

Returns:

a new builder instance.

self

@Nonnull
protected MatchPhrasePrefixQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<MatchPhrasePrefixQuery.Builder>

analyzer

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

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

API name: analyzer

field

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

Required - The target field

maxExpansions

@Nonnull
public final MatchPhrasePrefixQuery.Builder maxExpansions(@Nullable
 Integer value)

Maximum number of terms to which the last provided term of the query value will expand.

API name: max_expansions

query

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

Required - Text you wish to find in the provided field.

API name: query

slop

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

Maximum number of positions allowed between matching tokens.

API name: slop

zeroTermsQuery

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

API name: zero_terms_query

build

@Nonnull
public MatchPhrasePrefixQuery build()

Builds a MatchPhrasePrefixQuery.

Specified by:

build in interface ObjectBuilder<MatchPhrasePrefixQuery>

Throws:

NullPointerException - if some of the required fields are null.