t

zio.elasticsearch.query

HasChildQuery

sealed trait HasChildQuery[S] extends ElasticQuery[S] with HasIgnoreUnmapped[HasChildQuery[S]] with HasInnerHits[HasChildQuery[S]] with HasScoreMode[HasChildQuery[S]]

Linear Supertypes
HasScoreMode[HasChildQuery[S]], HasInnerHits[HasChildQuery[S]], HasIgnoreUnmapped[HasChildQuery[S]], ElasticQuery[S], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasChildQuery
  2. HasScoreMode
  3. HasInnerHits
  4. HasIgnoreUnmapped
  5. ElasticQuery
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def ignoreUnmapped(value: Boolean): HasChildQuery[S]

    Sets the ignoreUnmapped parameter to control whether to ignore unmapped fields and return empty hits.

    Sets the ignoreUnmapped parameter to control whether to ignore unmapped fields and return empty hits.

    value

    the boolean value for ignoreUnmapped parameter

    returns

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

    Definition Classes
    HasIgnoreUnmapped
  2. abstract def innerHits(innerHits: InnerHits): HasChildQuery[S]

    Sets the inner hits configuration for the zio.elasticsearch.query.NestedQuery.

    Sets the inner hits configuration for the zio.elasticsearch.query.NestedQuery.

    innerHits

    the configuration for inner hits

    returns

    a new instance of the zio.elasticsearch.query.ElasticQuery with the specified inner hits configuration.

    Definition Classes
    HasInnerHits
  3. abstract def maxChildren(value: Int): HasChildQuery[S]

    Sets the maxChildren parameter for the HasChildQuery.

    Sets the maxChildren parameter for the HasChildQuery. Indicates maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

    value

    the scala.Int value for maxChildren parameter

    returns

    an instance of HasChildQuery enriched with the maxChildren parameter.

  4. abstract def minChildren(value: Int): HasChildQuery[S]

    Sets the minChildren parameter for the HasChildQuery.

    Sets the minChildren parameter for the HasChildQuery. Indicates minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

    value

    the whole number value for minChildren parameter

    returns

    an instance of HasChildQuery enriched with the minChildren parameter.

  5. abstract def scoreMode(scoreMode: ScoreMode): HasChildQuery[S]

    Sets the ScoreMode for the zio.elasticsearch.query.NestedQuery.

    Sets the ScoreMode for the zio.elasticsearch.query.NestedQuery. The zio.elasticsearch.query.ScoreMode specifies how scores of matching documents are combined for the zio.elasticsearch.query.NestedQuery.

    scoreMode

    the ScoreMode to use for the zio.elasticsearch.query.NestedQuery

    • ScoreMode.Avg: uses the mean relevance score of all matching child objects
    • ScoreMode.Max: uses the highest relevance score of all matching child objects
    • ScoreMode.Min: uses the lowest relevance score of all matching child objects
    • ScoreMode.None: ignores relevance scores of matching child objects and uses 0 as a score
    • ScoreMode.Sum: adds together the relevance scores of all matching child objects
    returns

    a new instance of the zio.elasticsearch.query.ElasticQuery with the specified zio.elasticsearch.query.ScoreMode.

    Definition Classes
    HasScoreMode

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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def ignoreUnmappedFalse: HasChildQuery[S]

    Sets the ignoreUnmapped parameter to false for this zio.elasticsearch.query.ElasticQuery.

    Sets the ignoreUnmapped parameter to false for this zio.elasticsearch.query.ElasticQuery. Same as ignoreUnmapped(false).

    returns

    a new instance of the zio.elasticsearch.query.ElasticQuery with the ignoreUnmapped value set to false.

    Definition Classes
    HasIgnoreUnmapped
    See also

    #ignoreUnmapped

  11. final def ignoreUnmappedTrue: HasChildQuery[S]

    Sets the ignoreUnmapped parameter to true for this zio.elasticsearch.query.ElasticQuery.

    Sets the ignoreUnmapped parameter to true for this zio.elasticsearch.query.ElasticQuery. Same as ignoreUnmapped(true).

    returns

    a new instance of the zio.elasticsearch.query.ElasticQuery with the ignoreUnmapped value set to true.

    Definition Classes
    HasIgnoreUnmapped
    See also

    #ignoreUnmapped

  12. final def innerHits: HasChildQuery[S]

    Sets the inner hits for this zio.elasticsearch.query.ElasticQuery to the default InnerHits() value.

    Sets the inner hits for this zio.elasticsearch.query.ElasticQuery to the default InnerHits() value.

    returns

    a new instance of the zio.elasticsearch.query.ElasticQuery with the default inner hits.

    Definition Classes
    HasInnerHits
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from HasScoreMode[HasChildQuery[S]]

Inherited from HasInnerHits[HasChildQuery[S]]

Inherited from HasIgnoreUnmapped[HasChildQuery[S]]

Inherited from ElasticQuery[S]

Inherited from AnyRef

Inherited from Any

Ungrouped