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

Class CombinedFieldsQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.CombinedFieldsQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

CombinedFieldsQuery

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

Builder for CombinedFieldsQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CombinedFieldsQuery.Builder	autoGenerateSynonymsPhraseQuery(Boolean value)	If true, match phrase queries are automatically created for multi-term synonyms.
CombinedFieldsQuery	build()	Builds a CombinedFieldsQuery.
CombinedFieldsQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CombinedFieldsQuery.Builder	fields(String value, String... values)	Required - List of fields to search.
final CombinedFieldsQuery.Builder	fields(List<String> list)	Required - List of fields to search.
final CombinedFieldsQuery.Builder	minimumShouldMatch(String value)	API name: minimum_should_match
final CombinedFieldsQuery.Builder	operator(CombinedFieldsOperator value)	API name: operator
final CombinedFieldsQuery.Builder	query(String value)	Required - Text to search for in the provided fields.
protected CombinedFieldsQuery.Builder	self()
final CombinedFieldsQuery.Builder	zeroTermsQuery(CombinedFieldsZeroTerms 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 CombinedFieldsQuery.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<CombinedFieldsQuery.Builder,CombinedFieldsQuery>

Returns:

a new builder instance.

self

@Nonnull
protected CombinedFieldsQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<CombinedFieldsQuery.Builder>

autoGenerateSynonymsPhraseQuery

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

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

API name: auto_generate_synonyms_phrase_query

fields

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

Required - List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.

API name: fields

Adds all elements of list to fields.

fields

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

Required - List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.

API name: fields

Adds one or more values to fields.

minimumShouldMatch

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

API name: minimum_should_match

operator

@Nonnull
public final CombinedFieldsQuery.Builder operator(@Nullable
 CombinedFieldsOperator value)

API name: operator

query

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

Required - Text to search for in the provided fields. The combined_fields query analyzes the provided text before performing a search.

API name: query

zeroTermsQuery

@Nonnull
public final CombinedFieldsQuery.Builder zeroTermsQuery(@Nullable
 CombinedFieldsZeroTerms value)

API name: zero_terms_query

build

@Nonnull
public CombinedFieldsQuery build()

Builds a CombinedFieldsQuery.

Specified by:

build in interface ObjectBuilder<CombinedFieldsQuery>

Throws:

NullPointerException - if some of the required fields are null.