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

Class CombinedFieldsQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<CombinedFieldsQuery.Builder,CombinedFieldsQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class CombinedFieldsQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<CombinedFieldsQuery.Builder,CombinedFieldsQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CombinedFieldsQuery.Builder	Builder for CombinedFieldsQuery.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CombinedFieldsQuery>	_DESERIALIZER	Json deserializer for CombinedFieldsQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final Boolean	autoGenerateSynonymsPhraseQuery()	If true, match phrase queries are automatically created for multi-term synonyms.
static CombinedFieldsQuery.Builder	builder()
boolean	equals(Object o)
final List<String>	fields()	Required - List of fields to search.
int	hashCode()
final String	minimumShouldMatch()	API name: minimum_should_match
static CombinedFieldsQuery	of(Function<CombinedFieldsQuery.Builder,ObjectBuilder<CombinedFieldsQuery>> fn)
final CombinedFieldsOperator	operator()	API name: operator
final String	query()	Required - Text to search for in the provided fields.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCombinedFieldsQueryDeserializer(ObjectDeserializer<CombinedFieldsQuery.Builder> op)
CombinedFieldsQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final CombinedFieldsZeroTerms	zeroTermsQuery()	API name: zero_terms_query

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

toQuery

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CombinedFieldsQuery> _DESERIALIZER

Json deserializer for CombinedFieldsQuery

Method Details

of

public static CombinedFieldsQuery of(Function<CombinedFieldsQuery.Builder,ObjectBuilder<CombinedFieldsQuery>> fn)

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

autoGenerateSynonymsPhraseQuery

@Nullable
public final Boolean autoGenerateSynonymsPhraseQuery()

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

API name: auto_generate_synonyms_phrase_query

fields

@Nonnull
public final List<String> fields()

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

minimumShouldMatch

@Nullable
public final String minimumShouldMatch()

API name: minimum_should_match

operator

@Nullable
public final CombinedFieldsOperator operator()

API name: operator

query

@Nonnull
public final String query()

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

@Nullable
public final CombinedFieldsZeroTerms zeroTermsQuery()

API name: zero_terms_query

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public CombinedFieldsQuery.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CombinedFieldsQuery.Builder,CombinedFieldsQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static CombinedFieldsQuery.Builder builder()

setupCombinedFieldsQueryDeserializer

protected static void setupCombinedFieldsQueryDeserializer(ObjectDeserializer<CombinedFieldsQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase