t

zio.elasticsearch.ElasticRequest

SearchAndAggregateRequest

sealed trait SearchAndAggregateRequest extends ElasticRequest[SearchAndAggregateResult] with HasFrom[SearchAndAggregateRequest] with HasHighlights[SearchAndAggregateRequest] with HasRouting[SearchAndAggregateRequest] with HasSearchAfter[SearchAndAggregateRequest] with HasSize[SearchAndAggregateRequest] with HasSort[SearchAndAggregateRequest] with HasSourceFiltering[SearchAndAggregateRequest]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchAndAggregateRequest
  2. HasSourceFiltering
  3. HasSort
  4. HasSize
  5. HasSearchAfter
  6. HasRouting
  7. HasHighlights
  8. HasFrom
  9. ElasticRequest
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def excludes(field: String, fields: String*): SearchAndAggregateRequest

    Specifies one or more fields to be excluded in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    Specifies one or more fields to be excluded in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    field

    a field to be excluded

    fields

    fields to be excluded

    returns

    an instance of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest with specified fields to be excluded.

    Definition Classes
    HasSourceFiltering
  2. abstract def excludes[S](field: Field[S, _], fields: Field[S, _]*): SearchAndAggregateRequest

    Specifies one or more type-safe fields to be excluded in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    Specifies one or more type-safe fields to be excluded in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    S

    document which fields are excluded

    field

    a type-safe field to be excluded

    fields

    type-safe fields to be excluded

    returns

    an instance of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest with specified fields to be excluded.

    Definition Classes
    HasSourceFiltering
  3. abstract def from(value: Int): SearchAndAggregateRequest

    Sets the starting offset from where the zio.elasticsearch.ElasticRequest.SearchRequest or the zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest return results.

    Sets the starting offset from where the zio.elasticsearch.ElasticRequest.SearchRequest or the zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest return results.

    value

    a non-negative number to set the from parameter in the zio.elasticsearch.ElasticRequest

    returns

    an instance of the zio.elasticsearch.ElasticRequest enriched with the from parameter.

    Definition Classes
    HasFrom
  4. abstract def highlights(value: Highlights): SearchAndAggregateRequest

    Sets the zio.elasticsearch.highlights.Highlights for the zio.elasticsearch.ElasticRequest.

    Sets the zio.elasticsearch.highlights.Highlights for the zio.elasticsearch.ElasticRequest.

    value

    the zio.elasticsearch.highlights.Highlights to be set

    returns

    an instance of the zio.elasticsearch.ElasticRequest enriched with the highlights.

    Definition Classes
    HasHighlights
  5. abstract def includes[A](implicit schema: Record[A]): SearchAndAggregateRequest

    Specifies fields to be included in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest based on the schema of a case class.

    Specifies fields to be included in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest based on the schema of a case class.

    A

    a case class whose fields will be included in the response

    schema

    a record schema of A

    returns

    an instance of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest with specified fields to be excluded.

    Definition Classes
    HasSourceFiltering
  6. abstract def includes(field: String, fields: String*): SearchAndAggregateRequest

    Specifies one or more fields to be included in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    Specifies one or more fields to be included in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    field

    a field to be included

    fields

    fields to be included

    returns

    an instance of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest with specified fields to be included.

    Definition Classes
    HasSourceFiltering
  7. abstract def includes[S](field: Field[S, _], fields: Field[S, _]*): SearchAndAggregateRequest

    Specifies one or more type-safe fields to be included in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    Specifies one or more type-safe fields to be included in the response of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    field

    a type-safe field to be included

    fields

    type-safe fields to be included

    returns

    an instance of a zio.elasticsearch.ElasticRequest.SearchRequest or a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest with specified fields to be included.

    Definition Classes
    HasSourceFiltering
  8. abstract def routing(value: elasticsearch.Routing): SearchAndAggregateRequest

    Specifies a routing value to be used for this zio.elasticsearch.ElasticRequest.

    Specifies a routing value to be used for this zio.elasticsearch.ElasticRequest.

    value

    the Routing value to set for the zio.elasticsearch.ElasticRequest

    returns

    an instance of the zio.elasticsearch.ElasticRequest enriched with the routing parameter.

    Definition Classes
    HasRouting
  9. abstract def searchAfter(value: Json): SearchAndAggregateRequest

    Sets the search_after parameter for the zio.elasticsearch.ElasticRequest.

    Sets the search_after parameter for the zio.elasticsearch.ElasticRequest.

    value

    the JSON value to be set as the search_after parameter

    returns

    an instance of a zio.elasticsearch.ElasticRequest enriched with the search_after parameter.

    Definition Classes
    HasSearchAfter
  10. abstract def size(value: Int): SearchAndAggregateRequest

    Sets the maximum number of results.

    Sets the maximum number of results.

    value

    a non-negative number to set the size parameter in the zio.elasticsearch.ElasticRequest

    returns

    an instance of the zio.elasticsearch.ElasticRequest enriched with the size parameter.

    Definition Classes
    HasSize
  11. abstract def sort(sort: Sort, sorts: Sort*): SearchAndAggregateRequest

    Sets the sorting criteria for the zio.elasticsearch.ElasticRequest.SearchRequest or the zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    Sets the sorting criteria for the zio.elasticsearch.ElasticRequest.SearchRequest or the zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest.

    sort

    required zio.elasticsearch.query.sort.Sort object that define the sorting criteria

    sorts

    rest of the zio.elasticsearch.query.sort.Sort objects that define the sorting criteria

    returns

    an instance of the zio.elasticsearch.ElasticRequest enriched with the sorting criteria.

    Definition Classes
    HasSort

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. final def getFieldNames(schema: Record[_]): Chunk[String]
    Attributes
    protected
    Definition Classes
    HasSourceFiltering
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  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( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. 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 HasSourceFiltering[SearchAndAggregateRequest]

Inherited from HasSort[SearchAndAggregateRequest]

Inherited from HasSize[SearchAndAggregateRequest]

Inherited from HasSearchAfter[SearchAndAggregateRequest]

Inherited from HasRouting[SearchAndAggregateRequest]

Inherited from HasHighlights[SearchAndAggregateRequest]

Inherited from HasFrom[SearchAndAggregateRequest]

Inherited from ElasticRequest[SearchAndAggregateResult]

Inherited from AnyRef

Inherited from Any

Ungrouped