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

Class MatchBoolPrefixQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.MatchBoolPrefixQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

MatchBoolPrefixQuery

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

Builder for MatchBoolPrefixQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MatchBoolPrefixQuery.Builder	analyzer(String value)	Analyzer used to convert the text in the query value into tokens.
MatchBoolPrefixQuery	build()	Builds a MatchBoolPrefixQuery.
MatchBoolPrefixQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MatchBoolPrefixQuery.Builder	field(String value)	Required - The target field
final MatchBoolPrefixQuery.Builder	fuzziness(String value)	API name: fuzziness
final MatchBoolPrefixQuery.Builder	fuzzyRewrite(String value)	API name: fuzzy_rewrite
final MatchBoolPrefixQuery.Builder	fuzzyTranspositions(Boolean value)	If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).
final MatchBoolPrefixQuery.Builder	maxExpansions(Integer value)	Maximum number of terms to which the query will expand.
final MatchBoolPrefixQuery.Builder	minimumShouldMatch(String value)	API name: minimum_should_match
final MatchBoolPrefixQuery.Builder	operator(Operator value)	API name: operator
final MatchBoolPrefixQuery.Builder	prefixLength(Integer value)	Number of beginning characters left unchanged for fuzzy matching.
final MatchBoolPrefixQuery.Builder	query(String value)	Required - Terms you wish to find in the provided field.
protected MatchBoolPrefixQuery.Builder	self()

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 MatchBoolPrefixQuery.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<MatchBoolPrefixQuery.Builder,MatchBoolPrefixQuery>

Returns:

a new builder instance.

self

@Nonnull
protected MatchBoolPrefixQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<MatchBoolPrefixQuery.Builder>

analyzer

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

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

API name: analyzer

field

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

Required - The target field

fuzziness

@Nonnull
public final MatchBoolPrefixQuery.Builder fuzziness(@Nullable
 String value)

API name: fuzziness

fuzzyRewrite

@Nonnull
public final MatchBoolPrefixQuery.Builder fuzzyRewrite(@Nullable
 String value)

API name: fuzzy_rewrite

fuzzyTranspositions

@Nonnull
public final MatchBoolPrefixQuery.Builder fuzzyTranspositions(@Nullable
 Boolean value)

If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). Can be applied to the term subqueries constructed for all terms but the final term.

API name: fuzzy_transpositions

maxExpansions

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

Maximum number of terms to which the query will expand. Can be applied to the term subqueries constructed for all terms but the final term.

API name: max_expansions

minimumShouldMatch

@Nonnull
public final MatchBoolPrefixQuery.Builder minimumShouldMatch(@Nullable
 String value)

API name: minimum_should_match

operator

@Nonnull
public final MatchBoolPrefixQuery.Builder operator(@Nullable
 Operator value)

API name: operator

prefixLength

@Nonnull
public final MatchBoolPrefixQuery.Builder prefixLength(@Nullable
 Integer value)

Number of beginning characters left unchanged for fuzzy matching. Can be applied to the term subqueries constructed for all terms but the final term.

API name: prefix_length

query

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

Required - Terms you wish to find in the provided field. The last term is used in a prefix query.

API name: query

build

@Nonnull
public MatchBoolPrefixQuery build()

Builds a MatchBoolPrefixQuery.

Specified by:

build in interface ObjectBuilder<MatchBoolPrefixQuery>

Throws:

NullPointerException - if some of the required fields are null.