object FunctionScoreFunction
- Alphabetic
- By Inheritance
- FunctionScoreFunction
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def expDecayFunction(field: String, origin: String, scale: String): DecayFunction[Any]
Constructs an instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Exp using the specified parameters.Constructs an instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Exp using the specified parameters. zio.elasticsearch.query.DecayFunction is used to score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to a zio.elasticsearch.query.RangeQuery, but with smooth edges instead of boxes.- field
the field for which query is specified for
- origin
the point of origin used for calculating distance
- scale
defines the distance from origin + offset at which the computed score will equal
decay- returns
an instance of zio.elasticsearch.query.DecayFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def expDecayFunction[S](field: Field[S, _], origin: String, scale: String): DecayFunction[S]
Constructs a type-safe instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Exp using the specified parameters.Constructs a type-safe instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Exp using the specified parameters. zio.elasticsearch.query.DecayFunction is used to score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to a zio.elasticsearch.query.RangeQuery, but with smooth edges instead of boxes.- field
the type-safe field for which query is specified for
- origin
the point of origin used for calculating distance
- scale
defines the distance from origin + offset at which the computed score will equal
decayparameter- returns
an instance of zio.elasticsearch.query.DecayFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def fieldValueFactor(field: String): FieldValueFactor[Any]
Constructs an instance of zio.elasticsearch.query.FieldValueFactor using the specified parameters.
Constructs an instance of zio.elasticsearch.query.FieldValueFactor using the specified parameters. zio.elasticsearch.query.FieldValueFactor function allows you to use a field from a document to influence the score. It is similar to using the zio.elasticsearch.query.ScriptScoreFunction, however, it avoids the overhead of scripting. If used on a multi-valued field, only the first value of the field is used in calculations.
- field
the field to be extracted from the document
- returns
an instance of zio.elasticsearch.query.FieldValueFactor that represents the zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def fieldValueFactor[S](field: Field[S, _]): FieldValueFactor[S]
Constructs a type-safe instance of zio.elasticsearch.query.FieldValueFactor using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.FieldValueFactor using the specified parameters. zio.elasticsearch.query.FieldValueFactor function allows you to use a field from a document to influence the score. It is similar to using the zio.elasticsearch.query.ScriptScoreFunction, however, it avoids the overhead of scripting. If used on a multi-valued field, only the first value of the field is used in calculations.
- field
the type-safe field to be extracted from the document
- returns
an instance of zio.elasticsearch.query.FieldValueFactor that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def gaussDecayFunction(field: String, origin: String, scale: String): DecayFunction[Any]
Constructs an instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Gauss using the specified parameters.Constructs an instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Gauss using the specified parameters. zio.elasticsearch.query.DecayFunction is used to score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to a zio.elasticsearch.query.RangeQuery, but with smooth edges instead of boxes.- field
the field for which query is specified for
- origin
the point of origin used for calculating distance
- scale
defines the distance from origin + offset at which the computed score will equal
decay- returns
an instance of zio.elasticsearch.query.DecayFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def gaussDecayFunction[S](field: Field[S, _], origin: String, scale: String): DecayFunction[S]
Constructs a type-safe instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Gauss using the specified parameters.Constructs a type-safe instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Gauss using the specified parameters. zio.elasticsearch.query.DecayFunction is used to score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to zio.elasticsearch.query.RangeQuery, but with smooth edges instead of boxes.- field
the type-safe field for which query is specified for
- origin
the point of origin used for calculating distance
- scale
defines the distance from origin + offset at which the computed score will equal
decayparameter- returns
an instance of zio.elasticsearch.query.DecayFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def linearDecayFunction(field: String, origin: String, scale: String): DecayFunction[Any]
Constructs an instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Exp using the specified parameters.Constructs an instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Exp using the specified parameters. zio.elasticsearch.query.DecayFunction is used to score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to zio.elasticsearch.query.RangeQuery, but with smooth edges instead of boxes.- field
the field for which query is specified for
- origin
the point of origin used for calculating distance
- scale
defines the distance from origin + offset at which the computed score will equal
decay- returns
an instance of zio.elasticsearch.query.DecayFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def linearDecayFunction[S](field: Field[S, _], origin: String, scale: String): DecayFunction[S]
Constructs a type-safe instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Linear using the specified parameters.Constructs a type-safe instance of zio.elasticsearch.query.DecayFunction with
decayFunctionTypeof zio.elasticsearch.query.DecayFunctionType.Linear using the specified parameters. zio.elasticsearch.query.DecayFunction is used to score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to zio.elasticsearch.query.RangeQuery, but with smooth edges instead of boxes.- field
the type-safe field for which query is specified for
- origin
the point of origin used for calculating distance
- scale
defines the distance from origin + offset at which the computed score will equal
decayparameter- returns
an instance of zio.elasticsearch.query.DecayFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- 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 randomScoreFunction(seed: Long, field: String): RandomScoreFunction[Any]
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters. zio.elasticsearch.query.RandomScoreFunction generates scores that are uniformly distributed from 0 up to but not including 1. By default, it uses the internal Lucene doc IDs as a source of randomness, which is very efficient but unfortunately not reproducible since documents might be renumbered by merges.
- seed
the final score will be computed based on this value and value for field
- field
the field value that will be used to compute final score
- returns
an instance of zio.elasticsearch.query.RandomScoreFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def randomScoreFunction[S](seed: Long, field: Field[S, _]): RandomScoreFunction[S]
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters. zio.elasticsearch.query.RandomScoreFunction generates scores that are uniformly distributed from 0 up to but not including 1. By default, it uses the internal Lucene doc IDs as a source of randomness, which is very efficient but unfortunately not reproducible since documents might be renumbered by merges.
- seed
the final score will be computed based on this value and value for field
- field
the type-safe field for which zio.elasticsearch.query.RandomScoreFunction is specified for
- returns
an instance of zio.elasticsearch.query.RandomScoreFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def randomScoreFunction(seed: Long): RandomScoreFunction[Any]
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters. zio.elasticsearch.query.RandomScoreFunction generates scores that are uniformly distributed from 0 up to but not including 1. By default, it uses the internal Lucene doc IDs as a source of randomness, which is very efficient but unfortunately not reproducible since documents might be renumbered by merges.
- seed
the final score will be computed based on this value and default value for
fieldwhich is "_seq_no"- returns
an instance of zio.elasticsearch.query.RandomScoreFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def randomScoreFunction(): RandomScoreFunction[Any]
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.RandomScoreFunction using the specified parameters. zio.elasticsearch.query.RandomScoreFunction generates scores that are uniformly distributed from 0 up to but not including 1. By default, it uses the internal Lucene doc IDs as a source of randomness, which is very efficient but unfortunately not reproducible since documents might be renumbered by merges.
- returns
an instance of zio.elasticsearch.query.RandomScoreFunction that can be used in zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def scriptScoreFunction(scriptSource: String): ScriptScoreFunction[Any]
Constructs an instance of zio.elasticsearch.query.ScriptScoreFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.ScriptScoreFunction using the specified parameters. zio.elasticsearch.query.ScriptScoreFunction function allows you to wrap another zio.elasticsearch.query.ElasticQuery and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.
- scriptSource
the script source to use and create zio.elasticsearch.script.Script that will be used to calculate score
- returns
an instance of zio.elasticsearch.query.ScriptScoreFunction that represents the zio.elasticsearch.query.FunctionScoreQuery to be performed.
- def scriptScoreFunction(script: script.Script): ScriptScoreFunction[Any]
Constructs an instance of zio.elasticsearch.query.ScriptScoreFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.ScriptScoreFunction using the specified parameters. zio.elasticsearch.query.ScriptScoreFunction function allows you to wrap another zio.elasticsearch.query.ElasticQuery and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.
- script
the zio.elasticsearch.script.Script that will be used to calculate score
- returns
an instance of zio.elasticsearch.query.ScriptScoreFunction that represents the zio.elasticsearch.query.FunctionScoreQuery to be performed.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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 weightFunction(weight: Double): WeightFunction[Any]
Constructs an instance of zio.elasticsearch.query.WeightFunction using the specified parameters.
Constructs an instance of zio.elasticsearch.query.WeightFunction using the specified parameters. zio.elasticsearch.query.WeightFunction score allows you to multiply the score by the provided
weight.- weight
the non-negative number you wish to multiply the score with
- returns
an instance of zio.elasticsearch.query.WeightFunction that can be used to in zio.elasticsearch.query.FunctionScoreQuery.