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

Class FieldValueFactorScoreFunction

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.FieldValueFactorScoreFunction

All Implemented Interfaces:

FunctionScoreVariant, JsonpSerializable

@JsonpDeserializable
public class FieldValueFactorScoreFunction
extends Object
implements FunctionScoreVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
FunctionScore.Kind	_functionScoreKind()	FunctionScore variant kind.
final Double	factor()	Optional factor to multiply the field value with.
final String	field()	Required - Field to be extracted from the document.
final Double	missing()	Value used if the document doesn’t have that field.
final FieldValueFactorModifier	modifier()	Modifier to apply to the field value.
static FieldValueFactorScoreFunction	of(Function<FieldValueFactorScoreFunction.Builder,ObjectBuilder<FieldValueFactorScoreFunction>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFieldValueFactorScoreFunctionDeserializer(ObjectDeserializer<FieldValueFactorScoreFunction.Builder> op)
String	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.FunctionScoreVariant

_toFunctionScore

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FieldValueFactorScoreFunction> _DESERIALIZER

Json deserializer for FieldValueFactorScoreFunction

Method Details

of

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

_functionScoreKind

public FunctionScore.Kind _functionScoreKind()

FunctionScore variant kind.

Specified by:

_functionScoreKind in interface FunctionScoreVariant

field

public final String field()

Required - Field to be extracted from the document.

API name: field

factor

@Nullable
public final Double factor()

Optional factor to multiply the field value with.

API name: factor

missing

@Nullable
public final Double missing()

Value used if the document doesn’t have that field. The modifier and factor are still applied to it as though it were read from the document.

API name: missing

modifier

@Nullable
public final FieldValueFactorModifier modifier()

Modifier to apply to the field value.

API name: modifier

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toString

public String toString()

Overrides:

toString in class Object

setupFieldValueFactorScoreFunctionDeserializer

protected static void setupFieldValueFactorScoreFunctionDeserializer(ObjectDeserializer<FieldValueFactorScoreFunction.Builder> op)