t

zio.elasticsearch.query

QueryStringQuery

sealed trait QueryStringQuery[S] extends ElasticQuery[S] with HasFields[QueryStringQuery, S] with HasBoost[QueryStringQuery[S]] with HasMinimumShouldMatch[QueryStringQuery[S]]

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

Abstract Value Members

  1. abstract def boost(value: Double): QueryStringQuery[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 defaultField(value: String): QueryStringQuery[S]

    Sets the default_field parameter for the zio.elasticsearch.query.QueryStringQuery.

    Sets the default_field parameter for the zio.elasticsearch.query.QueryStringQuery. It is the field searched when the query string does not specify one.

    Elasticsearch does not allow default_field to be used together with fields, so setting default_field clears any previously set fields, and setting fields clears any previously set default_field.

    value

    the scala.Predef.String value for default_field parameter

    returns

    an instance of the zio.elasticsearch.query.QueryStringQuery enriched with the default_field parameter.

  3. abstract def fields[S1 <: S](field: Field[S1, _], fields: Field[S1, _]*)(implicit arg0: Schema[S1]): QueryStringQuery[S1]

    Sets the type-safe fields parameter for this zio.elasticsearch.query.ElasticQuery.

    Sets the type-safe fields parameter for this zio.elasticsearch.query.ElasticQuery. The fields parameter is array of type-safe fields that will be searched.

    S1

    a subtype of the base document type S representing the schema that contains the selected fields

    field

    the first type-safe field to include in the fields parameter

    fields

    an array of type-safe fields to set fields parameter to

    returns

    an instance of the zio.elasticsearch.query.ElasticQuery enriched with the type-safe fields parameter.

    Definition Classes
    HasFields
  4. abstract def fields[S1 <: S](fields: Chunk[Field[S1, _]])(implicit arg0: Schema[S1]): QueryStringQuery[S1]

    Sets the type-safe fields parameter for this zio.elasticsearch.query.ElasticQuery.

    Sets the type-safe fields parameter for this zio.elasticsearch.query.ElasticQuery. This version allows specifying multiple fields of different types (e.g. String, Int, Boolean) in a type-safe way using their respective definitions.

    S1

    a subtype of the base document type S representing the schema that contains the selected fields

    fields

    a chunk of type-safe fields to search within. These fields may be of any supported scalar type (such as String, Int, Boolean, etc.), and must be part of the document schema S1.

    returns

    an instance of the zio.elasticsearch.query.ElasticQuery enriched with the provided type-safe fields.

    Definition Classes
    HasFields
  5. abstract def fields(field: String, fields: String*): QueryStringQuery[S]

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

    Sets the fields parameter for this zio.elasticsearch.query.ElasticQuery. The fields parameter is array of fields that will be searched.

    field

    the first field to include in the fields parameter

    fields

    an array of fields to set fields parameter to

    returns

    an instance of the zio.elasticsearch.query.ElasticQuery enriched with the fields parameter.

    Definition Classes
    HasFields
  6. abstract def minimumShouldMatch(value: Int): QueryStringQuery[S]

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

    Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery. The minimumShouldMatch value is the number of should clauses returned documents must match. If the zio.elasticsearch.query.BoolQuery includes at least one should clause and no must/filter clauses, the default value is 1. Otherwise, the default value is 0.

    value

    a number to set minimumShouldMatch parameter to

    returns

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

    Definition Classes
    HasMinimumShouldMatch

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 ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  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(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. 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[QueryStringQuery[S]]

Inherited from HasBoost[QueryStringQuery[S]]

Inherited from HasFields[QueryStringQuery, S]

Inherited from ElasticQuery[S]

Inherited from AnyRef

Inherited from Any

Ungrouped