sealed trait TermsAggregation extends SingleElasticAggregation with HasOrder[TermsAggregation] with HasSize[TermsAggregation] with WithAgg with WithSubAgg[TermsAggregation]

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TermsAggregation
  2. WithSubAgg
  3. WithAgg
  4. HasSize
  5. HasOrder
  6. SingleElasticAggregation
  7. ElasticAggregation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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
  2. 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
  3. 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
  4. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. 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
  15. 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
  16. 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
  17. 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
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from WithSubAgg[TermsAggregation]

Inherited from WithAgg

Inherited from HasSize[TermsAggregation]

Inherited from HasOrder[TermsAggregation]

Inherited from ElasticAggregation

Inherited from AnyRef

Inherited from Any

Ungrouped