t

zio.elasticsearch.query

FunctionScoreQuery

sealed trait FunctionScoreQuery[S] extends ElasticQuery[S] with HasBoost[FunctionScoreQuery[S]]

Linear Supertypes
HasBoost[FunctionScoreQuery[S]], ElasticQuery[S], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FunctionScoreQuery
  2. HasBoost
  3. ElasticQuery
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def boost(value: Double): FunctionScoreQuery[S]

    Sets the boost parameter for this zio.elasticsearch.query.ElasticQuery.

    Sets the boost parameter for this zio.elasticsearch.query.ElasticQuery. The boost value 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 default boost value is 1.

    value

    a non-negative real number to set boost parameter to

    returns

    a new instance of the zio.elasticsearch.query.ElasticQuery with the boost value set.

    Definition Classes
    HasBoost
  2. abstract def boostMode(value: FunctionScoreBoostMode): FunctionScoreQuery[S]

    Sets the boostMode parameter for the zio.elasticsearch.query.FunctionScoreQuery.

    Sets the boostMode parameter 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:

    returns

    an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the boostMode parameter.

  3. abstract def maxBoost(value: Double): FunctionScoreQuery[S]

    Sets the maxBoost parameter for the zio.elasticsearch.query.FunctionScoreQuery.

    Sets the maxBoost parameter 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 maxBoost parameter.

  4. abstract def minScore(value: Double): FunctionScoreQuery[S]

    Sets the minScore parameter for the zio.elasticsearch.query.FunctionScoreQuery.

    Sets the minScore parameter for the zio.elasticsearch.query.FunctionScoreQuery. To exclude documents that do not meet a certain score threshold the minScore parameter 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 minScore parameter.

  5. abstract def query[S1 <: S](value: ElasticQuery[S1]): FunctionScoreQuery[S1]

    Sets the query parameter for the zio.elasticsearch.query.FunctionScoreQuery.

    Sets the query parameter 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 query parameter.

  6. abstract def scoreMode(value: FunctionScoreScoreMode): FunctionScoreQuery[S]

    Sets the scoreMode parameter for the zio.elasticsearch.query.FunctionScoreQuery.

    Sets the scoreMode parameter for the zio.elasticsearch.query.FunctionScoreQuery. The scoreMode parameter specifies how the computed scores are combined.

    value

    a value that we want to set scoreMode to, possible values are:

    returns

    an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the scoreMode parameter.

  7. 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 functionScoreFunctions parameter.

Concrete 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 equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from HasBoost[FunctionScoreQuery[S]]

Inherited from ElasticQuery[S]

Inherited from AnyRef

Inherited from Any

Ungrouped