Class MatchQuery.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<MatchQuery.Builder>
co.elastic.clients.elasticsearch._types.query_dsl.MatchQuery.Builder
- All Implemented Interfaces:
WithJson<MatchQuery.Builder>
,ObjectBuilder<MatchQuery>
- Enclosing class:
- MatchQuery
public static class MatchQuery.Builder
extends QueryBase.AbstractBuilder<MatchQuery.Builder>
implements ObjectBuilder<MatchQuery>
Builder for
MatchQuery
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal MatchQuery.Builder
Analyzer used to convert the text in the query value into tokens.final MatchQuery.Builder
Iftrue
, match phrase queries are automatically created for multi-term synonyms.build()
Builds aMatchQuery
.final MatchQuery.Builder
cutoffFrequency
(Double value) Deprecated.7.3.0final MatchQuery.Builder
Required - The target fieldfinal MatchQuery.Builder
Maximum edit distance allowed for matching.final MatchQuery.Builder
fuzzyRewrite
(String value) Method used to rewrite the query.final MatchQuery.Builder
fuzzyTranspositions
(Boolean value) Iftrue
, edits for fuzzy matching include transpositions of two adjacent characters (for example,ab
toba
).final MatchQuery.Builder
Iftrue
, 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) Minimum number of clauses that must match for a document to be returned.final MatchQuery.Builder
Boolean logic used to interpret text in the query value.final MatchQuery.Builder
prefixLength
(Integer value) Number of beginning characters left unchanged for fuzzy matching.final MatchQuery.Builder
query
(boolean value) Required - Text, number, boolean value or date you wish to find in the provided field.final MatchQuery.Builder
query
(double value) Required - Text, number, boolean value or date you wish to find in the provided field.final MatchQuery.Builder
query
(long value) 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.final MatchQuery.Builder
Required - Text, number, boolean value or date you wish to find in the provided field.final MatchQuery.Builder
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) Indicates whether no documents are returned if theanalyzer
removes all tokens, such as when using astop
filter.Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder
boost, queryName
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
field
Required - The target field -
analyzer
Analyzer used to convert the text in the query value into tokens.API name:
analyzer
-
autoGenerateSynonymsPhraseQuery
Iftrue
, match phrase queries are automatically created for multi-term synonyms.API name:
auto_generate_synonyms_phrase_query
-
cutoffFrequency
Deprecated.7.3.0API name:cutoff_frequency
-
fuzziness
Maximum edit distance allowed for matching.API name:
fuzziness
-
fuzzyRewrite
Method used to rewrite the query.API name:
fuzzy_rewrite
-
fuzzyTranspositions
Iftrue
, edits for fuzzy matching include transpositions of two adjacent characters (for example,ab
toba
).API name:
fuzzy_transpositions
-
lenient
Iftrue
, format-based errors, such as providing a text query value for a numeric field, are ignored.API name:
lenient
-
maxExpansions
Maximum number of terms to which the query will expand.API name:
max_expansions
-
minimumShouldMatch
Minimum number of clauses that must match for a document to be returned.API name:
minimum_should_match
-
operator
Boolean logic used to interpret text in the query value.API name:
operator
-
prefixLength
Number of beginning characters left unchanged for fuzzy matching.API name:
prefix_length
-
query
Required - Text, number, boolean value or date you wish to find in the provided field.API name:
query
-
query
Required - Text, number, boolean value or date you wish to find in the provided field.API name:
query
-
query
Required - Text, number, boolean value or date you wish to find in the provided field.API name:
query
-
query
Required - Text, number, boolean value or date you wish to find in the provided field.API name:
query
-
query
Required - Text, number, boolean value or date you wish to find in the provided field.API name:
query
-
query
Required - Text, number, boolean value or date you wish to find in the provided field.API name:
query
-
zeroTermsQuery
Indicates whether no documents are returned if theanalyzer
removes all tokens, such as when using astop
filter.API name:
zero_terms_query
-
self
- Specified by:
self
in classQueryBase.AbstractBuilder<MatchQuery.Builder>
-
build
Builds aMatchQuery
.- Specified by:
build
in interfaceObjectBuilder<MatchQuery>
- Throws:
NullPointerException
- if some of the required fields are null.
-