zio-elasticsearch
API
Generated with
zio-elasticsearch/zio.elasticsearch/ElasticRequest/SearchRequest

SearchRequest

zio.elasticsearch.ElasticRequest.SearchRequest
sealed trait SearchRequest extends ElasticRequest[SearchResult]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

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.

Value parameters

aggregation

zio.elasticsearch.ElasticAggregation object for aggregating documents

Attributes

Returns

an instance of a zio.elasticsearch.ElasticRequest.SearchAndAggregateRequest that represents search and aggregate operations to be performed.

Inherited methods

final protected def getFieldNames(schema: Record[_]): Chunk[String]

Attributes

Inherited from:
HasSourceFiltering (hidden)

Inherited and Abstract methods

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.

Value parameters

field

a field to be excluded

fields

fields to be excluded

Attributes

Returns

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

Inherited from:
HasSourceFiltering (hidden)
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.

Type parameters

S

document which fields are excluded

Value parameters

field

a type-safe field to be excluded

fields

type-safe fields to be excluded

Attributes

Returns

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

Inherited from:
HasSourceFiltering (hidden)
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 parameters

value

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

Attributes

Returns

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

Inherited from:
HasFrom (hidden)
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 parameters

value

the zio.elasticsearch.highlights.Highlights to be set

Attributes

Returns

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

Inherited from:
HasHighlights (hidden)
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.

Type parameters

A

a case class whose fields will be included in the response

Value parameters

schema

a record schema of A

Attributes

Returns

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

Inherited from:
HasSourceFiltering (hidden)
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.

Value parameters

field

a field to be included

fields

fields to be included

Attributes

Returns

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

Inherited from:
HasSourceFiltering (hidden)
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.

Value parameters

field

a type-safe field to be included

fields

type-safe fields to be included

Attributes

Returns

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

Inherited from:
HasSourceFiltering (hidden)
def routing(value: Routing): SearchRequest

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 parameters

value

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

Attributes

Returns

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

Inherited from:
HasRouting (hidden)
def searchAfter(value: Json): SearchRequest

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

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

Value parameters

value

the JSON value to be set as the search_after parameter

Attributes

Returns

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

Inherited from:
HasSearchAfter (hidden)
def size(value: Int): SearchRequest

Sets the maximum number of results.

Sets the maximum number of results.

Value parameters

value

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

Attributes

Returns

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

Inherited from:
HasSize (hidden)
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.

Value parameters

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

Attributes

Returns

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

Inherited from:
HasSort (hidden)
Generated with