sealed trait TermsAggregation extends SingleElasticAggregation with HasOrder[TermsAggregation] with HasSize[TermsAggregation] with WithAgg with WithSubAgg[TermsAggregation]
- Alphabetic
- By Inheritance
- TermsAggregation
- WithSubAgg
- WithAgg
- HasSize
- HasOrder
- SingleElasticAggregation
- ElasticAggregation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def orderBy(order: AggregationOrder, orders: AggregationOrder*): TermsAggregation
Sets the
order
parameter for the zio.elasticsearch.aggregation.ElasticAggregation.Sets the
order
parameter for the zio.elasticsearch.aggregation.ElasticAggregation. At least one zio.elasticsearch.aggregation.AggregationOrder must be specified.- 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
- returns
an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the
order
parameter.
- Definition Classes
- HasOrder
- abstract def size(value: Int): TermsAggregation
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
a non-negative number to set the
size
parameter in the zio.elasticsearch.aggregation.SingleElasticAggregation- returns
an instance of the zio.elasticsearch.aggregation.SingleElasticAggregation enriched with the
size
parameter.
- Definition Classes
- HasSize
- abstract 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.
- agg
the SingleElasticAggregation to add
- returns
a new instance of MultipleAggregations with the specified aggregation added to its list of aggregations.
- Definition Classes
- WithAgg
- abstract def withSubAgg(subAgg: SingleElasticAggregation): TermsAggregation
Adds a sub-aggregation to the aggregation.
Adds a sub-aggregation to the aggregation.
- subAgg
the SingleElasticAggregation to add as sub-aggregation
- returns
a new instance of the zio.elasticsearch.aggregation.ElasticAggregation with the given sub-aggregation.
- Definition Classes
- WithSubAgg
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()
- 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 orderByCountAsc: TermsAggregation
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.- returns
an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the
order
parameter.
- Definition Classes
- HasOrder
- final def orderByCountDesc: TermsAggregation
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.- returns
an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the
order
parameter.
- Definition Classes
- HasOrder
- final def orderByKeyAsc: TermsAggregation
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.- returns
an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the
order
parameter.
- Definition Classes
- HasOrder
- final def orderByKeyDesc: TermsAggregation
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.- returns
an instance of the zio.elasticsearch.aggregation.ElasticAggregation enriched with the
order
parameter.
- Definition Classes
- HasOrder
- 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])