Package co.elastic.clients.elasticsearch._types.query_dsl

Class BoolQuery

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

co.elastic.clients.elasticsearch._types.query_dsl.BoolQuery

All Implemented Interfaces:

QueryVariant, JsonpSerializable

@JsonpDeserializable
public class BoolQuery
extends QueryBase
implements QueryVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final List<Query>	filter()	The clause (query) must appear in matching documents.
boolean	hasClauses()	Returns true if this query has at least one should, must, must not or filter clause.
final String	minimumShouldMatch()	Specifies the number or percentage of should clauses returned documents must match.
final List<Query>	must()	The clause (query) must appear in matching documents and will contribute to the score.
final List<Query>	mustNot()	The clause (query) must not appear in the matching documents.
static BoolQuery	of(Function<BoolQuery.Builder,ObjectBuilder<BoolQuery>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupBoolQueryDeserializer(ObjectDeserializer<BoolQuery.Builder> op)
final List<Query>	should()	The clause (query) should appear in the matching document.

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant

_toQuery

Field Details

_DESERIALIZER

public static final JsonpDeserializer<BoolQuery> _DESERIALIZER

Json deserializer for BoolQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

filter

public final List<Query> filter()

The clause (query) must appear in matching documents. However, unlike must, the score of the query will be ignored.

API name: filter

minimumShouldMatch

@Nullable
public final String minimumShouldMatch()

Specifies the number or percentage of should clauses returned documents must match.

API name: minimum_should_match

must

public final List<Query> must()

The clause (query) must appear in matching documents and will contribute to the score.

API name: must

mustNot

public final List<Query> mustNot()

The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of 0 is returned for all documents.

API name: must_not

should

public final List<Query> should()

The clause (query) should appear in the matching document.

API name: should

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

setupBoolQueryDeserializer

protected static void setupBoolQueryDeserializer(ObjectDeserializer<BoolQuery.Builder> op)

hasClauses

public boolean hasClauses()

Returns true if this query has at least one should, must, must not or filter clause.