sealed trait FunctionScoreQuery[S] extends ElasticQuery[S] with HasBoost[FunctionScoreQuery[S]]
- Alphabetic
- By Inheritance
- FunctionScoreQuery
- HasBoost
- ElasticQuery
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def boost(value: Double): FunctionScoreQuery[S]
Sets the
boostparameter for this zio.elasticsearch.query.ElasticQuery.Sets the
boostparameter for this zio.elasticsearch.query.ElasticQuery. Theboostvalue is a positive multiplier applied to the score of documents matching the query. A value greater than 1 increases the relevance score of matching documents, while a value less than 1 decreases it. The defaultboostvalue is 1.- value
a non-negative real number to set
boostparameter to- returns
a new instance of the zio.elasticsearch.query.ElasticQuery with the
boostvalue set.
- Definition Classes
- HasBoost
- abstract def boostMode(value: FunctionScoreBoostMode): FunctionScoreQuery[S]
Sets the
boostModeparameter for the zio.elasticsearch.query.FunctionScoreQuery.Sets the
boostModeparameter for the zio.elasticsearch.query.FunctionScoreQuery. It defines how computed score is combined with score of the query.- value
Computed score and score of the query can be combined in following ways:
- zio.elasticsearch.query.FunctionScoreBoostMode.Avg
- zio.elasticsearch.query.FunctionScoreBoostMode.Max
- zio.elasticsearch.query.FunctionScoreBoostMode.Min
- zio.elasticsearch.query.FunctionScoreBoostMode.Multiply
- zio.elasticsearch.query.FunctionScoreBoostMode.Replace
- zio.elasticsearch.query.FunctionScoreBoostMode.Sum
- returns
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
boostModeparameter.
- abstract def maxBoost(value: Double): FunctionScoreQuery[S]
Sets the
maxBoostparameter for the zio.elasticsearch.query.FunctionScoreQuery.Sets the
maxBoostparameter for the zio.elasticsearch.query.FunctionScoreQuery. It restricts the new score not to exceed a certain limit by setting this parameter.- value
a non-negative real number used for the
maxBoost- returns
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
maxBoostparameter.
- abstract def minScore(value: Double): FunctionScoreQuery[S]
Sets the
minScoreparameter for the zio.elasticsearch.query.FunctionScoreQuery.Sets the
minScoreparameter for the zio.elasticsearch.query.FunctionScoreQuery. To exclude documents that do not meet a certain score threshold theminScoreparameter can be set to the desired score threshold.- value
a non-negative real number used for the
minScore- returns
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
minScoreparameter.
- abstract def query[S1 <: S](value: ElasticQuery[S1]): FunctionScoreQuery[S1]
Sets the
queryparameter for the zio.elasticsearch.query.FunctionScoreQuery.Sets the
queryparameter for the zio.elasticsearch.query.FunctionScoreQuery. Represents a query to be executed in elasticsearch and modified by zio.elasticsearch.query.FunctionScore parameters.- S1
the type of the zio.elasticsearch.query.ElasticQuery for type shrinking
- value
a zio.elasticsearch.query.ElasticQuery to be executed
- returns
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
queryparameter.
- abstract def scoreMode(value: FunctionScoreScoreMode): FunctionScoreQuery[S]
Sets the
scoreModeparameter for the zio.elasticsearch.query.FunctionScoreQuery.Sets the
scoreModeparameter for the zio.elasticsearch.query.FunctionScoreQuery. ThescoreModeparameter specifies how the computed scores are combined.- value
a value that we want to set
scoreModeto, possible values are:- zio.elasticsearch.query.FunctionScoreScoreMode.Avg
- zio.elasticsearch.query.FunctionScoreScoreMode.First
- zio.elasticsearch.query.FunctionScoreScoreMode.Max
- zio.elasticsearch.query.FunctionScoreScoreMode.Min
- zio.elasticsearch.query.FunctionScoreScoreMode.Multiply
- zio.elasticsearch.query.FunctionScoreScoreMode.None
- zio.elasticsearch.query.FunctionScoreScoreMode.Sum
- returns
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
scoreModeparameter.
- abstract def withFunctions[S1 <: S](functions: FunctionScoreFunction[S1]*): FunctionScoreQuery[S1]
Adds one or multiple zio.elasticsearch.query.FunctionScoreFunction to existing zio.elasticsearch.query.FunctionScore query.
Adds one or multiple zio.elasticsearch.query.FunctionScoreFunction to existing zio.elasticsearch.query.FunctionScore query.
- S1
the type of the zio.elasticsearch.query.FunctionScoreFunction for type shrinking
- functions
multiple zio.elasticsearch.query.FunctionScoreFunction to be added to query
- returns
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
functionScoreFunctionsparameter.
Concrete 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
- 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
- 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()
- 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])