final case class FieldValueFactor[S](field: String, factor: Option[Double], filter: Option[ElasticQuery[S]], modifier: Option[FieldValueFactorFunctionModifier], missing: Option[Double], weight: Option[Double]) extends FunctionScoreFunction[S] with Product with Serializable
- Self Type
- FieldValueFactor[S]
- Alphabetic
- By Inheritance
- FieldValueFactor
- Serializable
- Product
- Equals
- FunctionScoreFunction
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
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()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def factor(value: Double): FieldValueFactor[S]
Sets the
factor
parameter for the zio.elasticsearch.query.FieldValueFactor.Sets the
factor
parameter for the zio.elasticsearch.query.FieldValueFactor. Optional factor to multiply the field value with, defaults to 1.- value
a non-negative real number value for the
factor
parameter- returns
an instance of zio.elasticsearch.query.FieldValueFactor enriched with the
factor
parameter.
- val factor: Option[Double]
- val field: String
- def filter(filter: ElasticQuery[Any]): FieldValueFactor[Any]
- Definition Classes
- FieldValueFactor → FunctionScoreFunction
- def filter[S1 <: S](filter: ElasticQuery[S1])(implicit arg0: Schema[S1]): FieldValueFactor[S1]
- Definition Classes
- FieldValueFactor → FunctionScoreFunction
- val filter: Option[ElasticQuery[S]]
- Definition Classes
- FieldValueFactor → FunctionScoreFunction
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def missing(value: Double): FieldValueFactor[S]
Sets the
missing
parameter for the zio.elasticsearch.query.FieldValueFactor.Sets the
missing
parameter for the zio.elasticsearch.query.FieldValueFactor. Value used if the document does not have that field. The modifier and factor are still applied to it as though it were read from the document.- value
a non-negative real number value for the
missing
parameter- returns
an instance of zio.elasticsearch.query.FieldValueFactor enriched with the
missing
parameter.
- val missing: Option[Double]
- def modifier(value: FieldValueFactorFunctionModifier): FieldValueFactor[S]
Sets the
modifier
parameter for the zio.elasticsearch.query.FieldValueFactor.Sets the
modifier
parameter for the zio.elasticsearch.query.FieldValueFactor. Modifier to apply to the field value.- value
the zio.elasticsearch.query.FieldValueFactorFunctionModifier value for
modifier
parameter, it can be:- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Ln
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Ln1p
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Ln2p
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Log
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Log1p
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Log2p
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.None
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Reciprocal
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Sqrt
- zio.elasticsearch.query.FieldValueFactorFunctionModifier.Square
- returns
an instance of zio.elasticsearch.query.FieldValueFactor enriched with the
modifier
parameter.
- val modifier: Option[FieldValueFactorFunctionModifier]
- 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 productElementNames: Iterator[String]
- Definition Classes
- Product
- 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): FieldValueFactor[S]
Sets the
weight
parameter for the zio.elasticsearch.query.FieldValueFactor.Sets the
weight
parameter for the zio.elasticsearch.query.FieldValueFactor. 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.FieldValueFactor enriched with the
weight
parameter.
- val weight: Option[Double]