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 -
Method Summary
Modifier and TypeMethodDescriptionIftrue, match phrase queries are automatically created for multi-term synonyms.build()Builds aCombinedFieldsQuery.copy()Create a new builderCopyableBuilderthat is a copy of this one.Required - List of fields to search.Required - List of fields to search.minimumShouldMatch(String value) API name:minimum_should_matchoperator(CombinedFieldsOperator value) API name:operatorRequired - Text to search for in the providedfields.protected CombinedFieldsQuery.Builderself()API name:zero_terms_queryMethods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder
boost, queryNameMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<CombinedFieldsQuery.Builder,CombinedFieldsQuery> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classQueryBase.AbstractBuilder<CombinedFieldsQuery.Builder>
-
autoGenerateSynonymsPhraseQuery
@Nonnull public final CombinedFieldsQuery.Builder autoGenerateSynonymsPhraseQuery(@Nullable Boolean value) Iftrue, match phrase queries are automatically created for multi-term synonyms.API name:
auto_generate_synonyms_phrase_query -
fields
Required - List of fields to search. Field wildcard patterns are allowed. Onlytextfields are supported, and they must all have the same searchanalyzer.API name:
fieldsAdds all elements of
listtofields. -
fields
Required - List of fields to search. Field wildcard patterns are allowed. Onlytextfields are supported, and they must all have the same searchanalyzer.API name:
fieldsAdds one or more values to
fields. -
minimumShouldMatch
API name:minimum_should_match -
operator
API name:operator -
query
Required - Text to search for in the providedfields. Thecombined_fieldsquery 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
Builds aCombinedFieldsQuery.- Specified by:
buildin interfaceObjectBuilder<CombinedFieldsQuery>- Throws:
NullPointerException- if some of the required fields are null.
-