zio-elasticsearch
API
Generated with
zio-elasticsearch/zio.elasticsearch/zio.elasticsearch.aggregation/TermsAggregation

TermsAggregation

zio.elasticsearch.aggregation.TermsAggregation
sealed trait TermsAggregation extends SingleElasticAggregation

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Inherited methods

def orderBy(order: AggregationOrder, orders: AggregationOrder*): A

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation. At least one zio.elasticsearch.aggregation.AggregationOrder must be specified.

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation. At least one zio.elasticsearch.aggregation.AggregationOrder must be specified.

Value parameters

order

the required zio.elasticsearch.aggregation.AggregationOrder object defining the sort order for the aggregation results

orders

a list of zio.elasticsearch.aggregation.AggregationOrder defining the sort order for the aggregation results

Attributes

Returns

an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the order parameter.

Inherited from:
HasOrder (hidden)
final def orderByCountAsc: A

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _count field in ascending order.

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _count field in ascending order.

Attributes

Returns

an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the order parameter.

Inherited from:
HasOrder (hidden)
final def orderByCountDesc: A

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _count field in descending order.

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _count field in descending order.

Attributes

Returns

an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the order parameter.

Inherited from:
HasOrder (hidden)
final def orderByKeyAsc: A

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _key field in ascending order.

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _key field in ascending order.

Attributes

Returns

an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the order parameter.

Inherited from:
HasOrder (hidden)
final def orderByKeyDesc: A

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _key field in descending order.

Sets the order parameter for the zio.elasticsearch.aggregation.ElasticAggregation using the _key field in descending order.

Attributes

Returns

an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the order parameter.

Inherited from:
HasOrder (hidden)
def size(value: Int): A

Sets the maximum number of results to be returned by the aggregation.

Sets the maximum number of results to be returned by the aggregation.

Value parameters

value

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

Attributes

Returns

an instance of the zio.elasticsearch.aggregation.SingleElasticAggregation enriched with the size parameter.

Inherited from:
HasSize (hidden)
def withAgg(agg: SingleElasticAggregation): MultipleAggregations

Adds a new aggregation to the list of aggregations represented as MultipleAggregations.

Adds a new aggregation to the list of aggregations represented as MultipleAggregations.

Value parameters

agg

the SingleElasticAggregation to add

Attributes

Returns

a new instance of MultipleAggregations with the specified aggregation added to its list of aggregations.

Inherited from:
WithAgg (hidden)
def withSubAgg(subAgg: SingleElasticAggregation): A

Adds a sub-aggregation to the aggregation.

Adds a sub-aggregation to the aggregation.

Value parameters

subAgg

the SingleElasticAggregation to add as sub-aggregation

Attributes

Returns

a new instance of the zio.elasticsearch.aggregation.ElasticAggregation with the given sub-aggregation.

Inherited from:
WithSubAgg (hidden)
Generated with