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

Class DecayPlacement<TOrigin,TScale>

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.DecayPlacement<TOrigin,TScale>

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DecayPlacement<TOrigin,TScale>
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DecayPlacement.Builder<TOrigin,TScale>	Builder for DecayPlacement.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<DecayPlacement<Object,Object>>	_DESERIALIZER	Json deserializer for DecayPlacement based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <TOrigin, TScale> JsonpDeserializer<DecayPlacement<TOrigin,TScale>>	createDecayPlacementDeserializer(JsonpDeserializer<TOrigin> tOriginDeserializer, JsonpDeserializer<TScale> tScaleDeserializer)	Create a JSON deserializer for DecayPlacement
final Double	decay()	Defines how documents are scored at the distance given at scale.
static <TOrigin, TScale> DecayPlacement<TOrigin,TScale>	of(Function<DecayPlacement.Builder<TOrigin,TScale>,ObjectBuilder<DecayPlacement<TOrigin,TScale>>> fn)
final TScale	offset()	If defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset.
final TOrigin	origin()	The point of origin used for calculating distance.
final TScale	scale()	Defines the distance from origin + offset at which the computed score will equal decay parameter.
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 <TOrigin, TScale> void	setupDecayPlacementDeserializer(ObjectDeserializer<DecayPlacement.Builder<TOrigin,TScale>> op, JsonpDeserializer<TOrigin> tOriginDeserializer, JsonpDeserializer<TScale> tScaleDeserializer)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DecayPlacement<Object,Object>> _DESERIALIZER

Json deserializer for DecayPlacement based on named deserializers provided by the calling JsonMapper.

Method Details

of

public static <TOrigin,
TScale>
DecayPlacement<TOrigin,TScale> of(Function<DecayPlacement.Builder<TOrigin,TScale>,ObjectBuilder<DecayPlacement<TOrigin,TScale>>> fn)

decay

@Nullable
public final Double decay()

Defines how documents are scored at the distance given at scale.

API name: decay

offset

@Nullable
public final TScale offset()

If defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset.

API name: offset

scale

@Nullable
public final TScale scale()

Defines the distance from origin + offset at which the computed score will equal decay parameter.

API name: scale

origin

@Nullable
public final TOrigin origin()

The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields.

API name: origin

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

createDecayPlacementDeserializer

public static <TOrigin,
TScale>
JsonpDeserializer<DecayPlacement<TOrigin,TScale>> createDecayPlacementDeserializer(JsonpDeserializer<TOrigin> tOriginDeserializer,
 JsonpDeserializer<TScale> tScaleDeserializer)

Create a JSON deserializer for DecayPlacement

setupDecayPlacementDeserializer

protected static <TOrigin,
TScale> void setupDecayPlacementDeserializer(ObjectDeserializer<DecayPlacement.Builder<TOrigin,TScale>> op,
 JsonpDeserializer<TOrigin> tOriginDeserializer,
 JsonpDeserializer<TScale> tScaleDeserializer)