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:

ObjectBuilder<MatchQuery>

Enclosing class:

MatchQuery

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

Builder for MatchQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MatchQuery.Builder	analyzer(java.lang.String value)	API name: analyzer
MatchQuery.Builder	autoGenerateSynonymsPhraseQuery(java.lang.Boolean value)	API name: auto_generate_synonyms_phrase_query
MatchQuery	build()	Builds a MatchQuery.
MatchQuery.Builder	cutoffFrequency(java.lang.Double value)	Deprecated. 7.3.0
MatchQuery.Builder	field(java.lang.String value)	Required - The target field
MatchQuery.Builder	fuzziness(java.lang.String value)	API name: fuzziness
MatchQuery.Builder	fuzzyRewrite(java.lang.String value)	API name: fuzzy_rewrite
MatchQuery.Builder	fuzzyTranspositions(java.lang.Boolean value)	API name: fuzzy_transpositions
MatchQuery.Builder	lenient(java.lang.Boolean value)	API name: lenient
MatchQuery.Builder	maxExpansions(java.lang.Integer value)	API name: max_expansions
MatchQuery.Builder	minimumShouldMatch(java.lang.String value)	API name: minimum_should_match
MatchQuery.Builder	operator(Operator value)	API name: operator
MatchQuery.Builder	prefixLength(java.lang.Integer value)	API name: prefix_length
MatchQuery.Builder	query(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - API name: query
MatchQuery.Builder	query(FieldValue value)	Required - API name: query
protected MatchQuery.Builder	self()
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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

field

public final MatchQuery.Builder field(java.lang.String value)

Required - The target field

analyzer

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

API name: analyzer

autoGenerateSynonymsPhraseQuery

public final MatchQuery.Builder autoGenerateSynonymsPhraseQuery(@Nullable
                                                                java.lang.Boolean value)

API name: auto_generate_synonyms_phrase_query

cutoffFrequency

@Deprecated
public final MatchQuery.Builder cutoffFrequency(@Nullable
                                                java.lang.Double value)

Deprecated.

7.3.0

API name: cutoff_frequency

fuzziness

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

API name: fuzziness

fuzzyRewrite

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

API name: fuzzy_rewrite

fuzzyTranspositions

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

API name: fuzzy_transpositions

lenient

public final MatchQuery.Builder lenient(@Nullable
                                        java.lang.Boolean value)

API name: lenient

maxExpansions

public final MatchQuery.Builder maxExpansions(@Nullable
                                              java.lang.Integer value)

API name: max_expansions

minimumShouldMatch

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

API name: minimum_should_match

operator

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

API name: operator

prefixLength

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

API name: prefix_length

query

public final MatchQuery.Builder query(FieldValue value)

Required - API name: query

query

public final MatchQuery.Builder query(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Required - API name: query

zeroTermsQuery

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

API name: zero_terms_query

self

protected MatchQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<MatchQuery.Builder>

build

public MatchQuery build()

Builds a MatchQuery.

Specified by:

build in interface ObjectBuilder<MatchQuery>

Throws:

java.lang.NullPointerException - if some of the required fields are null.