zio-elasticsearch
API
Generated with
zio-elasticsearch/zio.elasticsearch/Elasticsearch

Elasticsearch

zio.elasticsearch.Elasticsearch
See theElasticsearch companion object
trait Elasticsearch

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def execute[A](request: ElasticRequest[A]): Task[A]

Executes the given ElasticRequest.

Executes the given ElasticRequest.

Type parameters

A

the type of the expected response

Value parameters

request

the zio.elasticsearch.ElasticRequest to execute

Attributes

Returns

a Task representing the response of the executed request.

def stream(request: SearchRequest): Stream[Throwable, Item]

Executes the given zio.elasticsearch.ElasticRequest.SearchRequest as a stream.

Executes the given zio.elasticsearch.ElasticRequest.SearchRequest as a stream.

Value parameters

request

the zio.elasticsearch.ElasticRequest.SearchRequest to execute

Attributes

Returns

a stream of zio.elasticsearch.result.Item.

def stream(request: SearchRequest, config: StreamConfig): Stream[Throwable, Item]

Executes a zio.elasticsearch.ElasticRequest.SearchRequest with a given StreamConfig.

Executes a zio.elasticsearch.ElasticRequest.SearchRequest with a given StreamConfig.

Value parameters

config

the zio.elasticsearch.StreamConfig object that represents configuration options for the stream

request

the zio.elasticsearch.ElasticRequest.SearchRequest to execute

Attributes

Returns

a stream of zio.elasticsearch.result.Item.

def streamAs[A : Schema](request: SearchRequest): Stream[Throwable, A]

Executes a zio.elasticsearch.ElasticRequest.SearchRequest and stream resulting documents as A, where A is a case class that has an implicit Schema instance in scope.

Executes a zio.elasticsearch.ElasticRequest.SearchRequest and stream resulting documents as A, where A is a case class that has an implicit Schema instance in scope.

Type parameters

A

the type of documents to be returned

Value parameters

request

the zio.elasticsearch.ElasticRequest.SearchRequest to execute

Attributes

Returns

a stream of the resulting documents as A.

def streamAs[A : Schema](request: SearchRequest, config: StreamConfig): Stream[Throwable, A]

Executes a zio.elasticsearch.ElasticRequest.SearchRequest and stream resulting documents as A, where A is a case class that has an implicit Schema instance in scope.

Executes a zio.elasticsearch.ElasticRequest.SearchRequest and stream resulting documents as A, where A is a case class that has an implicit Schema instance in scope.

Type parameters

A

the type of documents to be returned

Value parameters

config

the zio.elasticsearch.StreamConfig object that represents configuration options for the stream

request

the zio.elasticsearch.ElasticRequest.SearchRequest to execute

Attributes

Returns

a stream of the resulting documents as A.

Generated with