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

Class FunctionScoreQuery

java.lang.Object

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

co.elastic.clients.elasticsearch._types.query_dsl.FunctionScoreQuery

All Implemented Interfaces:

QueryVariant, JsonpSerializable

@JsonpDeserializable
public class FunctionScoreQuery
extends QueryBase
implements QueryVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<FunctionScoreQuery>	_DESERIALIZER	Json deserializer for FunctionScoreQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final FunctionBoostMode	boostMode()	Defines how he newly computed score is combined with the score of the query
final List<FunctionScore>	functions()	One or more functions that compute a new score for each document returned by the query.
final Double	maxBoost()	Restricts the new score to not exceed the provided limit.
final Double	minScore()	Excludes documents that do not meet the provided score threshold.
static FunctionScoreQuery	of(Function<FunctionScoreQuery.Builder,ObjectBuilder<FunctionScoreQuery>> fn)
final Query	query()	A query that determines the documents for which a new score is computed.
final FunctionScoreMode	scoreMode()	Specifies how the computed scores are combined
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFunctionScoreQueryDeserializer(ObjectDeserializer<FunctionScoreQuery.Builder> op)

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<FunctionScoreQuery> _DESERIALIZER

Json deserializer for FunctionScoreQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

boostMode

@Nullable
public final FunctionBoostMode boostMode()

Defines how he newly computed score is combined with the score of the query

API name: boost_mode

functions

public final List<FunctionScore> functions()

One or more functions that compute a new score for each document returned by the query.

API name: functions

maxBoost

@Nullable
public final Double maxBoost()

Restricts the new score to not exceed the provided limit.

API name: max_boost

minScore

@Nullable
public final Double minScore()

Excludes documents that do not meet the provided score threshold.

API name: min_score

query

@Nullable
public final Query query()

A query that determines the documents for which a new score is computed.

API name: query

scoreMode

@Nullable
public final FunctionScoreMode scoreMode()

Specifies how the computed scores are combined

API name: score_mode

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

setupFunctionScoreQueryDeserializer

protected static void setupFunctionScoreQueryDeserializer(ObjectDeserializer<FunctionScoreQuery.Builder> op)