c

zio.elasticsearch.query

FieldValueFactor

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]
Linear Supertypes
Serializable, Serializable, Product, Equals, FunctionScoreFunction[S], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldValueFactor
  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 FieldValueFactor(field: String, factor: Option[Double], filter: Option[ElasticQuery[S]], modifier: Option[FieldValueFactorFunctionModifier], missing: Option[Double], 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. 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.

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

  16. val missing: Option[Double]
  17. 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:

    returns

    an instance of zio.elasticsearch.query.FieldValueFactor enriched with the modifier parameter.

  18. val modifier: Option[FieldValueFactorFunctionModifier]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. 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 provided weight.

    value

    a non-negative real number value for the weight parameter

    returns

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

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