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

Class FieldValueFactorScoreFunction

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.FieldValueFactorScoreFunction

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, FunctionScoreVariant, ToCopyableBuilder<FieldValueFactorScoreFunction.Builder,FieldValueFactorScoreFunction>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class FieldValueFactorScoreFunction
extends Object
implements FunctionScoreVariant, PlainJsonSerializable, ToCopyableBuilder<FieldValueFactorScoreFunction.Builder,FieldValueFactorScoreFunction>

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.
static FieldValueFactorScoreFunction.Builder	builder()
boolean	equals(Object o)
final Float	factor()	Optional factor to multiply the field value with.
final String	field()	Required - API name: field
int	hashCode()
final Double	missing()	Value used if the document doesn't have that field.
final FieldValueFactorModifier	modifier()	API name: modifier
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)
FieldValueFactorScoreFunction.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.FunctionScoreVariant

toFunctionScore

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

factor

@Nullable
public final Float factor()

Optional factor to multiply the field value with.

API name: factor

field

@Nonnull
public final String field()

Required - API name: field

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

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)

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static FieldValueFactorScoreFunction.Builder builder()

setupFieldValueFactorScoreFunctionDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object