sealed trait SearchRequest extends ElasticRequest[SearchResult] with HasFrom[SearchRequest] with HasHighlights[SearchRequest] with HasRouting[SearchRequest] with HasSearchAfter[SearchRequest] with HasSize[SearchRequest] with HasSort[SearchRequest] with HasSourceFiltering[SearchRequest]
- Alphabetic
- By Inheritance
- SearchRequest
- HasSourceFiltering
- HasSort
- HasSize
- HasSearchAfter
- HasRouting
- HasHighlights
- HasFrom
- ElasticRequest
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def aggregate(aggregation: ElasticAggregation): SearchAndAggregateRequest
Adds an zio.elasticsearch.aggregation.ElasticAggregation to the zio.elasticsearch.ElasticRequest.SearchRequest.
Adds an zio.elasticsearch.aggregation.ElasticAggregation to the zio.elasticsearch.ElasticRequest.SearchRequest.
- aggregation
zio.elasticsearch.ElasticAggregation object for aggregating documents
- returns
an instance of a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest that represents search and aggregate operations to be performed.
- abstract def excludes(field: String, fields: String*): SearchRequest
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
- abstract def excludes[S](field: Field[S, _], fields: Field[S, _]*): SearchRequest
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
- abstract def from(value: Int): SearchRequest
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
fromparameter in the zio.elasticsearch.ElasticRequest- returns
an instance of the zio.elasticsearch.ElasticRequest enriched with the
fromparameter.
- Definition Classes
- HasFrom
- abstract def highlights(value: Highlights): SearchRequest
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
- abstract def includes[A](implicit schema: Record[A]): SearchRequest
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
- abstract def includes(field: String, fields: String*): SearchRequest
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
- abstract def includes[S](field: Field[S, _], fields: Field[S, _]*): SearchRequest
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
- abstract def routing(value: elasticsearch.Routing): SearchRequest
Specifies a
routingvalue to be used for this zio.elasticsearch.ElasticRequest.Specifies a
routingvalue 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
routingparameter.
- Definition Classes
- HasRouting
- abstract def searchAfter(value: Json): SearchRequest
Sets the
search_afterparameter for the zio.elasticsearch.ElasticRequest.Sets the
search_afterparameter for the zio.elasticsearch.ElasticRequest.- value
the JSON value to be set as the
search_afterparameter- returns
an instance of a zio.elasticsearch.ElasticRequest enriched with the
search_afterparameter.
- Definition Classes
- HasSearchAfter
- abstract def size(value: Int): SearchRequest
Sets the maximum number of results.
Sets the maximum number of results.
- value
a non-negative number to set the
sizeparameter in the zio.elasticsearch.ElasticRequest- returns
an instance of the zio.elasticsearch.ElasticRequest enriched with the
sizeparameter.
- Definition Classes
- HasSize
- abstract def sort(sort: Sort, sorts: Sort*): SearchRequest
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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def getFieldNames(schema: Record[_]): Chunk[String]
- Attributes
- protected
- Definition Classes
- HasSourceFiltering
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])