final case class DecayFunction[S](field: String, decayFunctionType: DecayFunctionType, origin: String, scale: String, decay: Option[Double], filter: Option[ElasticQuery[S]], multiValueMode: Option[MultiValueMode], offset: Option[String], weight: Option[Double]) extends FunctionScoreFunction[S] with Product with Serializable
- Self Type
- DecayFunction[S]
- Alphabetic
- By Inheritance
- DecayFunction
- Serializable
- Product
- Equals
- FunctionScoreFunction
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DecayFunction(field: String, decayFunctionType: DecayFunctionType, origin: String, scale: String, decay: Option[Double], filter: Option[ElasticQuery[S]], multiValueMode: Option[MultiValueMode], offset: Option[String], weight: Option[Double])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def decay(value: Double): DecayFunction[S]
Sets the
decay
parameter for the zio.elasticsearch.query.DecayFunction.Sets the
decay
parameter for the zio.elasticsearch.query.DecayFunction. It defines how documents are scored at the distance given at scale. If no decay is defined, documents at the distance scale will be scored 0.5.- value
a non-negative real number value for the
decay
parameter- returns
an instance of zio.elasticsearch.query.DecayFunction enriched with the
decay
parameter.
- val decay: Option[Double]
- val decayFunctionType: DecayFunctionType
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val field: String
- def filter(filter: ElasticQuery[Any]): DecayFunction[Any]
- Definition Classes
- DecayFunction → FunctionScoreFunction
- def filter[S1 <: S](filter: ElasticQuery[S1])(implicit arg0: Schema[S1]): DecayFunction[S1]
- Definition Classes
- DecayFunction → FunctionScoreFunction
- val filter: Option[ElasticQuery[S]]
- Definition Classes
- DecayFunction → FunctionScoreFunction
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def multiValueMode(value: MultiValueMode): DecayFunction[S]
Sets the
multiValueMode
parameter for the zio.elasticsearch.query.DecayFunction.Sets the
multiValueMode
parameter for the zio.elasticsearch.query.DecayFunction. If a field used for computing the decay contains multiple values, per default the value closest to the origin is chosen for determining the distance. This can be changed by settingmultiValueMode
.- value
the zio.elasticsearch.query.MultiValueMode value for
multiValueMode
parameter, it can have following values:- returns
an instance of zio.elasticsearch.query.DecayFunction enriched with the
multiValueMode
parameter.
- val multiValueMode: Option[MultiValueMode]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def offset(value: String): DecayFunction[S]
Sets the
offset
parameter for the zio.elasticsearch.query.DecayFunction.Sets the
offset
parameter for the zio.elasticsearch.query.DecayFunction. If an offset is defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset. The default is 0.- value
the text value for the
offset
parameter- returns
an instance of zio.elasticsearch.query.DecayFunction enriched with the
offset
parameter.
- val offset: Option[String]
- val origin: String
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val scale: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def weight(value: Double): DecayFunction[S]
Sets the
weight
parameter for the zio.elasticsearch.query.DecayFunction.Sets the
weight
parameter for the zio.elasticsearch.query.DecayFunction. The weight score allows you to multiply the score by the providedweight
.- value
a non-negative real number value for the
weight
parameter- returns
an instance of zio.elasticsearch.query.DecayFunction enriched with the
weight
parameter.
- val weight: Option[Double]