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

ZIOAggregationsOps

zio.elasticsearch.package$.ZIOAggregationsOps
final implicit class ZIOAggregationsOps[R](zio: RIO[R, ResultWithAggregation])

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def aggregation(name: String): RIO[R, Option[AggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce an optional result.AggregationResult.

def aggregationAs[A <: AggregationResult](name: String): RIO[R, Option[A]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Type parameters

A

type of the aggregation to retrieve, must be subtype of result.AggregationResult

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of parameter A.

def aggregations: RIO[R, Map[String, AggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Attributes

Returns

a RIO effect that, when executed, will produce a Map of the aggregations name and result.AggregationResult.

def asAvgAggregation(name: String): RIO[R, Option[AvgAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.AvgAggregationResult.

def asCardinalityAggregation(name: String): RIO[R, Option[CardinalityAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.CardinalityAggregationResult.

def asMaxAggregation(name: String): RIO[R, Option[MaxAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.MaxAggregationResult.

def asMinAggregation(name: String): RIO[R, Option[MinAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.MinAggregationResult.

def asMissingAggregation(name: String): RIO[R, Option[MissingAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.MissingAggregationResult.

def asSumAggregation(name: String): RIO[R, Option[SumAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.SumAggregationResult.

def asTermsAggregation(name: String): RIO[R, Option[TermsAggregationResult]]

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Executes the ElasticRequest.SearchRequest or the ElasticRequest.SearchAndAggregateRequest.

Value parameters

name

the name of the aggregation to retrieve

Attributes

Returns

a RIO effect that, when executed, will produce the aggregation as instance of result.TermsAggregationResult.

Generated with