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

Class FunctionScore

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.FunctionScore

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<FunctionScore.Kind,java.lang.Object>

@JsonpDeserializable
public class FunctionScore
extends java.lang.Object
implements TaggedUnion<FunctionScore.Kind,java.lang.Object>, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionScore.Builder
static class	FunctionScore.Kind	FunctionScore variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<FunctionScore>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
FunctionScore(FunctionScoreVariant value)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
FunctionScore.Kind	_kind()	Get the of the kind of variant held by this object.
DecayFunction	exp()	Get the exp variant value.
FieldValueFactorScoreFunction	fieldValueFactor()	Get the field_value_factor variant value.
Query	filter()	API name: filter
DecayFunction	gauss()	Get the gauss variant value.
boolean	isExp()	Is this variant instance of kind exp?
boolean	isFieldValueFactor()	Is this variant instance of kind field_value_factor?
boolean	isGauss()	Is this variant instance of kind gauss?
boolean	isLinear()	Is this variant instance of kind linear?
boolean	isRandomScore()	Is this variant instance of kind random_score?
boolean	isScriptScore()	Is this variant instance of kind script_score?
DecayFunction	linear()	Get the linear variant value.
static FunctionScore	of(java.util.function.Function<FunctionScore.Builder,ObjectBuilder<FunctionScore>> fn)
RandomScoreFunction	randomScore()	Get the random_score variant value.
ScriptScoreFunction	scriptScore()	Get the script_score variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFunctionScoreDeserializer(ObjectDeserializer<FunctionScore.Builder> op)
java.lang.Double	weight()	API name: weight

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<FunctionScore> _DESERIALIZER

Constructor Detail

FunctionScore

public FunctionScore(FunctionScoreVariant value)

Method Detail

_kind

public final FunctionScore.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<FunctionScore.Kind,java.lang.Object>

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<FunctionScore.Kind,java.lang.Object>

of

public static FunctionScore of(java.util.function.Function<FunctionScore.Builder,ObjectBuilder<FunctionScore>> fn)

filter

@Nullable
public final Query filter()

API name: filter

weight

@Nullable
public final java.lang.Double weight()

API name: weight

isExp

public boolean isExp()

Is this variant instance of kind exp?

exp

public DecayFunction exp()

Get the exp variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the exp kind.

isGauss

public boolean isGauss()

Is this variant instance of kind gauss?

gauss

public DecayFunction gauss()

Get the gauss variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the gauss kind.

isLinear

public boolean isLinear()

Is this variant instance of kind linear?

linear

public DecayFunction linear()

Get the linear variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the linear kind.

isFieldValueFactor

public boolean isFieldValueFactor()

Is this variant instance of kind field_value_factor?

fieldValueFactor

public FieldValueFactorScoreFunction fieldValueFactor()

Get the field_value_factor variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the field_value_factor kind.

isRandomScore

public boolean isRandomScore()

Is this variant instance of kind random_score?

randomScore

public RandomScoreFunction randomScore()

Get the random_score variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the random_score kind.

isScriptScore

public boolean isScriptScore()

Is this variant instance of kind script_score?

scriptScore

public ScriptScoreFunction scriptScore()

Get the script_score variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the script_score kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

setupFunctionScoreDeserializer

protected static void setupFunctionScoreDeserializer(ObjectDeserializer<FunctionScore.Builder> op)