java.lang.Object
- org.elasticsearch.index.query.AbstractQueryBuilder<MultiMatchQueryBuilder>
- - org.elasticsearch.index.query.MultiMatchQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>
```
public class MultiMatchQueryBuilder
extends AbstractQueryBuilder<MultiMatchQueryBuilder>
```
Same as MatchQueryBuilder but supports multiple fields.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MultiMatchQueryBuilder.Type
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`DEFAULT_FUZZY_TRANSPOSITIONS`
`static int`	`DEFAULT_MAX_EXPANSIONS`
`static Operator`	`DEFAULT_OPERATOR`
`static int`	`DEFAULT_PHRASE_SLOP`
`static int`	`DEFAULT_PREFIX_LENGTH`
`static MultiMatchQueryBuilder.Type`	`DEFAULT_TYPE`
`static MatchQuery.ZeroTermsQuery`	`DEFAULT_ZERO_TERMS_QUERY`
`static String`	`NAME`

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS

Constructor Summary

Constructors
Constructor	Description
`MultiMatchQueryBuilder(Object value, String... fields)`	Constructs a new text query.
`MultiMatchQueryBuilder(StreamInput in)`	Read from a stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`analyzer()`
`MultiMatchQueryBuilder`	`analyzer(String analyzer)`	Explicitly set the analyzer to use.
`boolean`	`autoGenerateSynonymsPhraseQuery()`	Whether phrase queries should be automatically generated for multi terms synonyms.
`MultiMatchQueryBuilder`	`autoGenerateSynonymsPhraseQuery(boolean enable)`
`Float`	`cutoffFrequency()`
`MultiMatchQueryBuilder`	`cutoffFrequency(float cutoff)`	Deprecated. Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.
`MultiMatchQueryBuilder`	`cutoffFrequency(Float cutoff)`	Deprecated. Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.
`protected boolean`	`doEquals(MultiMatchQueryBuilder other)`	Indicates whether some other `QueryBuilder` object of the same type is "equal to" this one.
`protected int`	`doHashCode()`
`protected Query`	`doToQuery(QueryShardContext context)`
`protected void`	`doWriteTo(StreamOutput out)`
`void`	`doXContent(XContentBuilder builder, ToXContent.Params params)`
`MultiMatchQueryBuilder`	`field(String field)`	Adds a field to run the multi match against.
`MultiMatchQueryBuilder`	`field(String field, float boost)`	Adds a field to run the multi match against with a specific boost.
`Map<String,Float>`	`fields()`
`MultiMatchQueryBuilder`	`fields(Map<String,Float> fields)`	Add several fields to run the query against with a specific boost.
`static MultiMatchQueryBuilder`	`fromXContent(XContentParser parser)`
`Fuzziness`	`fuzziness()`
`MultiMatchQueryBuilder`	`fuzziness(Object fuzziness)`	Sets the fuzziness used when evaluated to a fuzzy query type.
`String`	`fuzzyRewrite()`
`MultiMatchQueryBuilder`	`fuzzyRewrite(String fuzzyRewrite)`
`boolean`	`fuzzyTranspositions()`
`MultiMatchQueryBuilder`	`fuzzyTranspositions(boolean fuzzyTranspositions)`	Sets whether transpositions are supported in fuzzy queries.
`MultiMatchQueryBuilder.Type`	`getType()`	Returns the type (for testing)
`String`	`getWriteableName()`	Returns the name of the writeable object
`boolean`	`lenient()`
`MultiMatchQueryBuilder`	`lenient(boolean lenient)`	Sets whether format based failures will be ignored.
`int`	`maxExpansions()`
`MultiMatchQueryBuilder`	`maxExpansions(int maxExpansions)`	When using fuzzy or prefix type query, the number of term expansions to use.
`String`	`minimumShouldMatch()`
`MultiMatchQueryBuilder`	`minimumShouldMatch(String minimumShouldMatch)`
`Operator`	`operator()`
`MultiMatchQueryBuilder`	`operator(Operator operator)`	Sets the operator to use when using a boolean query.
`int`	`prefixLength()`
`MultiMatchQueryBuilder`	`prefixLength(int prefixLength)`
`int`	`slop()`
`MultiMatchQueryBuilder`	`slop(int slop)`	Set the phrase slop if evaluated to a phrase query type.
`Float`	`tieBreaker()`
`MultiMatchQueryBuilder`	`tieBreaker(float tieBreaker)`	Tie-Breaker for "best-match" disjunction queries (OR-Queries).
`MultiMatchQueryBuilder`	`tieBreaker(Float tieBreaker)`	Tie-Breaker for "best-match" disjunction queries (OR-Queries).
`MultiMatchQueryBuilder.Type`	`type()`
`MultiMatchQueryBuilder`	`type(Object type)`	Sets the type of the text query.
`MultiMatchQueryBuilder`	`type(MultiMatchQueryBuilder.Type type)`	Sets the type of the text query.
`Object`	`value()`
`MatchQuery.ZeroTermsQuery`	`zeroTermsQuery()`
`MultiMatchQueryBuilder`	`zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)`

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TYPE
```
public static final MultiMatchQueryBuilder.Type DEFAULT_TYPE
```
  - DEFAULT_OPERATOR
```
public static final Operator DEFAULT_OPERATOR
```
  - DEFAULT_PHRASE_SLOP
```
public static final int DEFAULT_PHRASE_SLOP
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PREFIX_LENGTH
```
public static final int DEFAULT_PREFIX_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_EXPANSIONS
```
public static final int DEFAULT_MAX_EXPANSIONS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ZERO_TERMS_QUERY
```
public static final MatchQuery.ZeroTermsQuery DEFAULT_ZERO_TERMS_QUERY
```
  - DEFAULT_FUZZY_TRANSPOSITIONS
```
public static final boolean DEFAULT_FUZZY_TRANSPOSITIONS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MultiMatchQueryBuilder
```
public MultiMatchQueryBuilder(Object value,
                              String... fields)
```
    Constructs a new text query.
  - MultiMatchQueryBuilder
```
public MultiMatchQueryBuilder(StreamInput in)
                       throws IOException
```
    Read from a stream.
    
    Throws:
    
    IOException
- Method Detail
  - getType
```
public MultiMatchQueryBuilder.Type getType()
```
    Returns the type (for testing)
  - doWriteTo
```
protected void doWriteTo(StreamOutput out)
                  throws IOException
```
    Specified by:
    
    doWriteTo in class AbstractQueryBuilder<MultiMatchQueryBuilder>
    
    Throws:
    
    IOException
  - value
```
public Object value()
```
  - field
```
public MultiMatchQueryBuilder field(String field)
```
    Adds a field to run the multi match against.
  - field
```
public MultiMatchQueryBuilder field(String field,
                                    float boost)
```
    Adds a field to run the multi match against with a specific boost.
  - fields
```
public MultiMatchQueryBuilder fields(Map<String,Float> fields)
```
    Add several fields to run the query against with a specific boost.
  - fields
```
public Map<String,Float> fields()
```
  - type
```
public MultiMatchQueryBuilder type(MultiMatchQueryBuilder.Type type)
```
    Sets the type of the text query.
  - type
```
public MultiMatchQueryBuilder type(Object type)
```
    Sets the type of the text query.
  - type
```
public MultiMatchQueryBuilder.Type type()
```
  - operator
```
public MultiMatchQueryBuilder operator(Operator operator)
```
    Sets the operator to use when using a boolean query. Defaults to OR.
  - operator
```
public Operator operator()
```
  - analyzer
```
public MultiMatchQueryBuilder analyzer(String analyzer)
```
    Explicitly set the analyzer to use. Defaults to use explicit mapping config for the field, or, if not set, the default search analyzer.
  - analyzer
```
public String analyzer()
```
  - slop
```
public MultiMatchQueryBuilder slop(int slop)
```
    Set the phrase slop if evaluated to a phrase query type.
  - slop
```
public int slop()
```
  - fuzziness
```
public MultiMatchQueryBuilder fuzziness(Object fuzziness)
```
    Sets the fuzziness used when evaluated to a fuzzy query type. Defaults to "AUTO".
  - fuzziness
```
public Fuzziness fuzziness()
```
  - prefixLength
```
public MultiMatchQueryBuilder prefixLength(int prefixLength)
```
  - prefixLength
```
public int prefixLength()
```
  - maxExpansions
```
public MultiMatchQueryBuilder maxExpansions(int maxExpansions)
```
    When using fuzzy or prefix type query, the number of term expansions to use. Defaults to unbounded so its recommended to set it to a reasonable value for faster execution.
  - maxExpansions
```
public int maxExpansions()
```
  - minimumShouldMatch
```
public MultiMatchQueryBuilder minimumShouldMatch(String minimumShouldMatch)
```
  - minimumShouldMatch
```
public String minimumShouldMatch()
```
  - fuzzyRewrite
```
public MultiMatchQueryBuilder fuzzyRewrite(String fuzzyRewrite)
```
  - fuzzyRewrite
```
public String fuzzyRewrite()
```
  - tieBreaker
```
public MultiMatchQueryBuilder tieBreaker(float tieBreaker)
```
    Tie-Breaker for "best-match" disjunction queries (OR-Queries). The tie breaker capability allows documents that match more than one query clause (in this case on more than one field) to be scored better than documents that match only the best of the fields, without confusing this with the better case of two distinct matches in the multiple fields.
    
    A tie-breaker value of 1.0 is interpreted as a signal to score queries as "most-match" queries where all matching query clauses are considered for scoring.
    
    See Also:
    
    MultiMatchQueryBuilder.Type
  - tieBreaker
```
public MultiMatchQueryBuilder tieBreaker(Float tieBreaker)
```
    Tie-Breaker for "best-match" disjunction queries (OR-Queries). The tie breaker capability allows documents that match more than one query clause (in this case on more than one field) to be scored better than documents that match only the best of the fields, without confusing this with the better case of two distinct matches in the multiple fields.
    
    A tie-breaker value of 1.0 is interpreted as a signal to score queries as "most-match" queries where all matching query clauses are considered for scoring.
    
    See Also:
    
    MultiMatchQueryBuilder.Type
  - tieBreaker
```
public Float tieBreaker()
```
  - lenient
```
public MultiMatchQueryBuilder lenient(boolean lenient)
```
    Sets whether format based failures will be ignored.
  - lenient
```
public boolean lenient()
```
  - cutoffFrequency
```
@Deprecated
public MultiMatchQueryBuilder cutoffFrequency(float cutoff)
```
    Deprecated.
    Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.
    
    Set a cutoff value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term.
  - cutoffFrequency
```
@Deprecated
public MultiMatchQueryBuilder cutoffFrequency(Float cutoff)
```
    Deprecated.
    Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.
    
    Set a cutoff value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term.
  - cutoffFrequency
```
public Float cutoffFrequency()
```
  - zeroTermsQuery
```
public MultiMatchQueryBuilder zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)
```
  - zeroTermsQuery
```
public MatchQuery.ZeroTermsQuery zeroTermsQuery()
```
  - autoGenerateSynonymsPhraseQuery
```
public MultiMatchQueryBuilder autoGenerateSynonymsPhraseQuery(boolean enable)
```
  - autoGenerateSynonymsPhraseQuery
```
public boolean autoGenerateSynonymsPhraseQuery()
```
    Whether phrase queries should be automatically generated for multi terms synonyms. Defaults to true.
  - fuzzyTranspositions
```
public boolean fuzzyTranspositions()
```
  - fuzzyTranspositions
```
public MultiMatchQueryBuilder fuzzyTranspositions(boolean fuzzyTranspositions)
```
    Sets whether transpositions are supported in fuzzy queries.
    The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein distance formula which supports transpositions. Setting transposition to false will switch to classic Levenshtein distance.
    If not set, Damerau-Levenshtein distance metric will be used.
  - doXContent
```
public void doXContent(XContentBuilder builder,
                       ToXContent.Params params)
                throws IOException
```
    Specified by:
    
    doXContent in class AbstractQueryBuilder<MultiMatchQueryBuilder>
    
    Throws:
    
    IOException
  - fromXContent
```
public static MultiMatchQueryBuilder fromXContent(XContentParser parser)
                                           throws IOException
```
    Throws:
    
    IOException
  - getWriteableName
```
public String getWriteableName()
```
    Description copied from interface: NamedWriteable
    
    Returns the name of the writeable object
  - doToQuery
```
protected Query doToQuery(QueryShardContext context)
                   throws IOException
```
    Specified by:
    
    doToQuery in class AbstractQueryBuilder<MultiMatchQueryBuilder>
    
    Throws:
    
    IOException
  - doHashCode
```
protected int doHashCode()
```
    Specified by:
    
    doHashCode in class AbstractQueryBuilder<MultiMatchQueryBuilder>
  - doEquals
```
protected boolean doEquals(MultiMatchQueryBuilder other)
```
    Description copied from class: AbstractQueryBuilder
    
    Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
    
    Specified by:
    
    doEquals in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Class MultiMatchQueryBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

Field Detail

NAME

DEFAULT_TYPE

DEFAULT_OPERATOR

DEFAULT_PHRASE_SLOP

DEFAULT_PREFIX_LENGTH

DEFAULT_MAX_EXPANSIONS

DEFAULT_ZERO_TERMS_QUERY

DEFAULT_FUZZY_TRANSPOSITIONS

Constructor Detail

MultiMatchQueryBuilder

MultiMatchQueryBuilder

Method Detail

getType

doWriteTo

value

field

field

fields

fields

type

type

type

operator

operator

analyzer

analyzer

slop

slop

fuzziness

fuzziness

prefixLength

prefixLength

maxExpansions

maxExpansions

minimumShouldMatch

minimumShouldMatch

fuzzyRewrite

fuzzyRewrite

tieBreaker

tieBreaker

tieBreaker

lenient

lenient

cutoffFrequency

cutoffFrequency

cutoffFrequency

zeroTermsQuery

zeroTermsQuery

autoGenerateSynonymsPhraseQuery

autoGenerateSynonymsPhraseQuery

fuzzyTranspositions

fuzzyTranspositions

doXContent

fromXContent

getWriteableName

doToQuery

doHashCode

doEquals