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

Class DecayPlacement.Builder<TOrigin,TScale>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<DecayPlacement.Builder<TOrigin,TScale>>

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

All Implemented Interfaces:

WithJson<DecayPlacement.Builder<TOrigin,TScale>>, ObjectBuilder<DecayPlacement<TOrigin,TScale>>

Enclosing class:

DecayPlacement<TOrigin,TScale>

public static class DecayPlacement.Builder<TOrigin,TScale>
extends WithJsonObjectBuilderBase<DecayPlacement.Builder<TOrigin,TScale>>
implements ObjectBuilder<DecayPlacement<TOrigin,TScale>>

Builder for DecayPlacement.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DecayPlacement<TOrigin,TScale>	build()	Builds a DecayPlacement.
final DecayPlacement.Builder<TOrigin,TScale>	decay(Double value)	Defines how documents are scored at the distance given at scale.
final DecayPlacement.Builder<TOrigin,TScale>	offset(TScale value)	If defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset.
final DecayPlacement.Builder<TOrigin,TScale>	origin(TOrigin value)	The point of origin used for calculating distance.
final DecayPlacement.Builder<TOrigin,TScale>	scale(TScale value)	Defines the distance from origin + offset at which the computed score will equal decay parameter.
protected DecayPlacement.Builder<TOrigin,TScale>	self()
final DecayPlacement.Builder<TOrigin,TScale>	tOriginSerializer(JsonpSerializer<TOrigin> value)	Serializer for TOrigin.
final DecayPlacement.Builder<TOrigin,TScale>	tScaleSerializer(JsonpSerializer<TScale> value)	Serializer for TScale.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

decay

public final DecayPlacement.Builder<TOrigin,TScale> decay(@Nullable
 Double value)

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

API name: decay

offset

public final DecayPlacement.Builder<TOrigin,TScale> offset(@Nullable
 TScale value)

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

public final DecayPlacement.Builder<TOrigin,TScale> scale(@Nullable
 TScale value)

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

API name: scale

origin

public final DecayPlacement.Builder<TOrigin,TScale> origin(@Nullable
 TOrigin value)

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

tOriginSerializer

public final DecayPlacement.Builder<TOrigin,TScale> tOriginSerializer(@Nullable
 JsonpSerializer<TOrigin> value)

Serializer for TOrigin. If not set, an attempt will be made to find a serializer from the JSON context.

tScaleSerializer

public final DecayPlacement.Builder<TOrigin,TScale> tScaleSerializer(@Nullable
 JsonpSerializer<TScale> value)

Serializer for TScale. If not set, an attempt will be made to find a serializer from the JSON context.

self

protected DecayPlacement.Builder<TOrigin,TScale> self()

Specified by:

self in class WithJsonObjectBuilderBase<DecayPlacement.Builder<TOrigin,TScale>>

build

public DecayPlacement<TOrigin,TScale> build()

Builds a DecayPlacement.

Specified by:

build in interface ObjectBuilder<TOrigin>

Throws:

NullPointerException - if some of the required fields are null.