c

zio.elasticsearch.query

DecayFunction

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]
Linear Supertypes
Serializable, Serializable, Product, Equals, FunctionScoreFunction[S], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DecayFunction
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FunctionScoreFunction
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. 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.

  7. val decay: Option[Double]
  8. val decayFunctionType: DecayFunctionType
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val field: String
  11. def filter[S1 <: S](filter: ElasticQuery[S1])(implicit arg0: Schema[S1]): DecayFunction[S1]
    Definition Classes
    DecayFunction → FunctionScoreFunction
  12. def filter(filter: ElasticQuery[Any]): DecayFunction[Any]
    Definition Classes
    DecayFunction → FunctionScoreFunction
  13. val filter: Option[ElasticQuery[S]]
    Definition Classes
    DecayFunction → FunctionScoreFunction
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. 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 setting multiValueMode.

    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.

  17. val multiValueMode: Option[MultiValueMode]
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. 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.

  22. val offset: Option[String]
  23. val origin: String
  24. val scale: String
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. 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 provided weight.

    value

    a non-negative real number value for the weight parameter

    returns

    an instance of zio.elasticsearch.query.DecayFunction enriched with the weight parameter.

  30. val weight: Option[Double]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FunctionScoreFunction[S]

Inherited from AnyRef

Inherited from Any

Ungrouped