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, PlainJsonSerializable, TaggedUnion<FunctionScore.Kind,FunctionScoreVariant>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class FunctionScore
extends Object
implements TaggedUnion<FunctionScore.Kind,FunctionScoreVariant>, PlainJsonSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<FunctionScore>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
FunctionScore(FunctionScoreVariant value)

Method Summary

Modifier and Type	Method	Description
final FunctionScoreVariant	_get()
final FunctionScore.Kind	_kind()	Get the of the kind of variant held by this object.
static FunctionScore.Builder	builder()
boolean	equals(Object o)
DecayFunction	exp()	Get the exp variant value.
FieldValueFactorScoreFunction	fieldValueFactor()	Get the field_value_factor variant value.
final Query	filter()	API name: filter
DecayFunction	gauss()	Get the gauss variant value.
int	hashCode()
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(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)
FunctionScore.Builder	toBuilder()
final Float	weight()	API name: weight

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FunctionScore> _DESERIALIZER

Constructor Details

FunctionScore

public FunctionScore(FunctionScoreVariant value)

Method Details

_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,FunctionScoreVariant>

Returns:

the variant kind

_get

public final FunctionScoreVariant _get()

Specified by:

_get in interface TaggedUnion<FunctionScore.Kind,FunctionScoreVariant>

of

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

filter

@Nullable
public final Query filter()

API name: filter

weight

@Nullable
public final Float 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:

IllegalStateException - if the current variant is not the exp 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:

IllegalStateException - if the current variant is not the field_value_factor kind.

isGauss

public boolean isGauss()

Is this variant instance of kind gauss?

gauss

public DecayFunction gauss()

Get the gauss variant value.

Throws:

IllegalStateException - if the current variant is not the gauss kind.

isLinear

public boolean isLinear()

Is this variant instance of kind linear?

linear

public DecayFunction linear()

Get the linear variant value.

Throws:

IllegalStateException - if the current variant is not the linear kind.

isRandomScore

public boolean isRandomScore()

Is this variant instance of kind random_score?

randomScore

public RandomScoreFunction randomScore()

Get the random_score variant value.

Throws:

IllegalStateException - if the current variant is not 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:

IllegalStateException - if the current variant is not the script_score kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public FunctionScore.Builder toBuilder()

builder

@Nonnull
public static FunctionScore.Builder builder()

setupFunctionScoreDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object