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

Class MatchQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.MatchQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

MatchQuery

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

Builder for MatchQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected MatchQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<MatchQuery.Builder>

analyzer

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

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

API name: analyzer

autoGenerateSynonymsPhraseQuery

@Nonnull
public final MatchQuery.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 MatchQuery.Builder cutoffFrequency(@Nullable
 Float value)

API name: cutoff_frequency

field

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

Required - The target field

fuzziness

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

API name: fuzziness

fuzzyRewrite

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

API name: fuzzy_rewrite

fuzzyTranspositions

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

If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).

API name: fuzzy_transpositions

lenient

@Nonnull
public final MatchQuery.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 MatchQuery.Builder maxExpansions(@Nullable
 Integer value)

Maximum number of terms to which the query will expand.

API name: max_expansions

minimumShouldMatch

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

API name: minimum_should_match

operator

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

API name: operator

prefixLength

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

Number of beginning characters left unchanged for fuzzy matching.

API name: prefix_length

query

@Nonnull
public final MatchQuery.Builder query(FieldValue value)

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

API name: query

query

@Nonnull
public final MatchQuery.Builder query(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

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

API name: query

zeroTermsQuery

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

API name: zero_terms_query

build

@Nonnull
public MatchQuery build()

Builds a MatchQuery.

Specified by:

build in interface ObjectBuilder<MatchQuery>

Throws:

NullPointerException - if some of the required fields are null.