sealed trait BoolQuery[S] extends ElasticQuery[S] with HasBoost[BoolQuery[S]] with HasMinimumShouldMatch[BoolQuery[S]]

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

Abstract Value Members

  1. abstract def boost(value: Double): BoolQuery[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 filter(queries: ElasticQuery[Any]*): BoolQuery[S]

    Adds specified filter queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified filter queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents. Unlike must the score of the query will be ignored.

    queries

    the filter queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with filter queries added.

  3. abstract def filter[S1 <: S](queries: ElasticQuery[S1]*)(implicit arg0: Schema[S1]): BoolQuery[S1]

    Adds specified filter queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified filter queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents. Unlike must the score of the query will be ignored.

    S1

    the type of the sub-queries, for which an implicit zio.schema.Schema is required

    queries

    the filter queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with filter queries added.

  4. abstract def minimumShouldMatch(value: MinimumShouldMatch): BoolQuery[S]

    Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery.

    Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery. The minimumShouldMatch value is the minimum number of optional clauses (e.g. should clauses of a zio.elasticsearch.query.BoolQuery or terms of a full text query) that returned documents must match. Its default value depends on the query type.

    value

    the zio.elasticsearch.query.MinimumShouldMatch to set minimumShouldMatch parameter to, possible values are:

    returns

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

    Definition Classes
    HasMinimumShouldMatch
  5. abstract def must(queries: ElasticQuery[Any]*): BoolQuery[S]

    Adds specified must queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified must queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents and will contribute to the score.

    queries

    the must queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with must queries added.

  6. abstract def must[S1 <: S](queries: ElasticQuery[S1]*)(implicit arg0: Schema[S1]): BoolQuery[S1]

    Adds specified must queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified must queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents and will contribute to the score.

    S1

    the type of the sub-queries, for which an implicit zio.schema.Schema is required

    queries

    the must queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with must queries added.

  7. abstract def mustNot(queries: ElasticQuery[Any]*): BoolQuery[S]

    Adds specified must not queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified must not queries to the zio.elasticsearch.query.BoolQuery. These queries must not appear in matching documents.

    queries

    the must not queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with must not queries added.

  8. abstract def mustNot[S1 <: S](queries: ElasticQuery[S1]*)(implicit arg0: Schema[S1]): BoolQuery[S1]

    Adds specified must not queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified must not queries to the zio.elasticsearch.query.BoolQuery. These queries must not appear in matching documents.

    S1

    the type of the sub-queries, for which an implicit zio.schema.Schema is required

    queries

    the must not queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with must not queries added.

  9. abstract def should(queries: ElasticQuery[Any]*): BoolQuery[S]

    Adds specified should queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified should queries to the zio.elasticsearch.query.BoolQuery. These queries should appear in matching documents.

    queries

    the should queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with should queries added.

  10. abstract def should[S1 <: S](queries: ElasticQuery[S1]*)(implicit arg0: Schema[S1]): BoolQuery[S1]

    Adds specified should queries to the zio.elasticsearch.query.BoolQuery.

    Adds specified should queries to the zio.elasticsearch.query.BoolQuery. These queries should appear in matching documents.

    S1

    the type of the sub-queries, for which an implicit zio.schema.Schema is required

    queries

    the should queries to be added

    returns

    an instance of the zio.elasticsearch.query.BoolQuery with should queries added.

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 isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def minimumShouldMatch(value: Int): BoolQuery[S]

    Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery.

    Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery. The minimumShouldMatch value is the minimum number of optional clauses (e.g. should clauses of a zio.elasticsearch.query.BoolQuery or terms of a full text query) that returned documents must match. Its default value depends on the query type.

    This is a shorthand for minimumShouldMatch(MinimumShouldMatch.Count(value)).

    value

    a number to set minimumShouldMatch parameter to; a negative number is the number of optional clauses that may be missing

    returns

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

    Definition Classes
    HasMinimumShouldMatch
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. 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 HasMinimumShouldMatch[BoolQuery[S]]

Inherited from HasBoost[BoolQuery[S]]

Inherited from ElasticQuery[S]

Inherited from AnyRef

Inherited from Any

Ungrouped