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

Class DecayPlacement.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<DecayPlacement.Builder>

co.elastic.clients.elasticsearch._types.query_dsl.DecayPlacement.Builder

All Implemented Interfaces:

WithJson<DecayPlacement.Builder>, ObjectBuilder<DecayPlacement>

Enclosing class:

DecayPlacement

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

Builder for DecayPlacement.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DecayPlacement	build()	Builds a DecayPlacement.
final DecayPlacement.Builder	decay(Double value)	Defines how documents are scored at the distance given at scale.
final DecayPlacement.Builder	offset(JsonData 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	origin(JsonData value)	The point of origin used for calculating distance.
final DecayPlacement.Builder	scale(JsonData value)	Defines the distance from origin + offset at which the computed score will equal decay parameter.
protected DecayPlacement.Builder	self()

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 decay(@Nullable
 Double value)

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

API name: decay

offset

public final DecayPlacement.Builder offset(@Nullable
 JsonData 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 scale(@Nullable
 JsonData value)

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

API name: scale

origin

public final DecayPlacement.Builder origin(@Nullable
 JsonData 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

self

protected DecayPlacement.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DecayPlacement.Builder>

build

public DecayPlacement build()

Builds a DecayPlacement.

Specified by:

build in interface ObjectBuilder<DecayPlacement>

Throws:

NullPointerException - if some of the required fields are null.