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

Class MultiMatchQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.MultiMatchQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

MultiMatchQuery

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

Builder for MultiMatchQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MultiMatchQuery.Builder	analyzer(String value)	Analyzer used to convert the text in the query value into tokens.
final MultiMatchQuery.Builder	autoGenerateSynonymsPhraseQuery(Boolean value)	If true, match phrase queries are automatically created for multi-term synonyms.
MultiMatchQuery	build()	Builds a MultiMatchQuery.
MultiMatchQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MultiMatchQuery.Builder	cutoffFrequency(Float value)	API name: cutoff_frequency
final MultiMatchQuery.Builder	fields(String value, String... values)	API name: fields
final MultiMatchQuery.Builder	fields(List<String> list)	API name: fields
final MultiMatchQuery.Builder	fuzziness(String value)	API name: fuzziness
final MultiMatchQuery.Builder	fuzzyRewrite(String value)	API name: fuzzy_rewrite
final MultiMatchQuery.Builder	fuzzyTranspositions(Boolean value)	If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).
final MultiMatchQuery.Builder	lenient(Boolean value)	If true, format-based errors, such as providing a text query value for a numeric field, are ignored.
final MultiMatchQuery.Builder	maxExpansions(Integer value)	Maximum number of terms to which the query will expand.
final MultiMatchQuery.Builder	minimumShouldMatch(String value)	API name: minimum_should_match
final MultiMatchQuery.Builder	operator(Operator value)	API name: operator
final MultiMatchQuery.Builder	prefixLength(Integer value)	Number of beginning characters left unchanged for fuzzy matching.
final MultiMatchQuery.Builder	query(String value)	Required - Text, number, Boolean value or date you wish to find in the provided field.
protected MultiMatchQuery.Builder	self()
final MultiMatchQuery.Builder	slop(Integer value)	Maximum number of positions allowed between matching tokens.
final MultiMatchQuery.Builder	tieBreaker(Float value)	Determines how scores for each per-term blended query and scores across groups are combined.
final MultiMatchQuery.Builder	type(TextQueryType value)	API name: type
final MultiMatchQuery.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 MultiMatchQuery.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<MultiMatchQuery.Builder,MultiMatchQuery>

Returns:

a new builder instance.

self

@Nonnull
protected MultiMatchQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<MultiMatchQuery.Builder>

analyzer

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

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

API name: analyzer

autoGenerateSynonymsPhraseQuery

@Nonnull
public final MultiMatchQuery.Builder autoGenerateSynonymsPhraseQuery(@Nullable
 Boolean value)

If true, match phrase queries are automatically created for multi-term synonyms.

API name: auto_generate_synonyms_phrase_query

cutoffFrequency

@Nonnull
public final MultiMatchQuery.Builder cutoffFrequency(@Nullable
 Float value)

API name: cutoff_frequency

fields

@Nonnull
public final MultiMatchQuery.Builder fields(List<String> list)

API name: fields

Adds all elements of list to fields.

fields

@Nonnull
public final MultiMatchQuery.Builder fields(String value,
 String... values)

API name: fields

Adds one or more values to fields.

fuzziness

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

API name: fuzziness

fuzzyRewrite

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

API name: fuzzy_rewrite

fuzzyTranspositions

@Nonnull
public final MultiMatchQuery.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

lenient

@Nonnull
public final MultiMatchQuery.Builder lenient(@Nullable
 Boolean value)

If true, format-based errors, such as providing a text query value for a numeric field, are ignored.

API name: lenient

maxExpansions

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

Maximum number of terms to which the query will expand.

API name: max_expansions

minimumShouldMatch

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

API name: minimum_should_match

operator

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

API name: operator

prefixLength

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

Number of beginning characters left unchanged for fuzzy matching.

API name: prefix_length

query

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

Required - Text, number, Boolean value or date you wish to find in the provided field.

API name: query

slop

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

Maximum number of positions allowed between matching tokens.

API name: slop

tieBreaker

@Nonnull
public final MultiMatchQuery.Builder tieBreaker(@Nullable
 Float value)

Determines how scores for each per-term blended query and scores across groups are combined.

API name: tie_breaker

type

@Nonnull
public final MultiMatchQuery.Builder type(@Nullable
 TextQueryType value)

API name: type

zeroTermsQuery

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

API name: zero_terms_query

build

@Nonnull
public MultiMatchQuery build()

Builds a MultiMatchQuery.

Specified by:

build in interface ObjectBuilder<MultiMatchQuery>

Throws:

NullPointerException - if some of the required fields are null.