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

Class FunctionScoreQuery

java.lang.Object

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

org.opensearch.client.opensearch._types.query_dsl.FunctionScoreQuery

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final FunctionBoostMode	boostMode()	API name: boost_mode
static FunctionScoreQuery.Builder	builder()
boolean	equals(Object o)
final List<FunctionScore>	functions()	One or more functions that compute a new score for each document returned by the query.
int	hashCode()
final Float	maxBoost()	Restricts the new score to not exceed the provided limit.
final Float	minScore()	Excludes documents that do not meet the provided score threshold.
static FunctionScoreQuery	of(Function<FunctionScoreQuery.Builder,ObjectBuilder<FunctionScoreQuery>> fn)
final Query	query()	API name: query
final FunctionScoreMode	scoreMode()	API name: score_mode
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFunctionScoreQueryDeserializer(ObjectDeserializer<FunctionScoreQuery.Builder> op)
FunctionScoreQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<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()

API name: boost_mode

functions

@Nonnull
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 Float maxBoost()

Restricts the new score to not exceed the provided limit.

API name: max_boost

minScore

@Nullable
public final Float minScore()

Excludes documents that do not meet the provided score threshold.

API name: min_score

query

@Nullable
public final Query query()

API name: query

scoreMode

@Nullable
public final FunctionScoreMode scoreMode()

API name: score_mode

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public FunctionScoreQuery.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<FunctionScoreQuery.Builder,FunctionScoreQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static FunctionScoreQuery.Builder builder()

setupFunctionScoreQueryDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase