Class

com.sksamuel.elastic4s.searches.aggs

TermsAggregationDefinition

Related Doc: package aggs

Permalink

case class TermsAggregationDefinition(name: String, field: Option[String] = None, script: Option[ScriptDefinition] = None, missing: Option[AnyRef] = None, size: Option[Int] = None, minDocCount: Option[Long] = None, showTermDocCountError: Option[Boolean] = None, valueType: Option[ValueType] = None, executionHint: Option[String] = None, shardMinDocCount: Option[Long] = None, collectMode: Option[SubAggCollectionMode] = None, _oldOrder: Option[Order] = None, order: Option[TermsOrder] = None, shardSize: Option[Int] = None, includeExclude: Option[IncludeExclude] = None, subaggs: Seq[AbstractAggregation] = Nil, metadata: Map[String, AnyRef] = Map.empty) extends AggregationDefinition with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AggregationDefinition, AbstractAggregation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TermsAggregationDefinition
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AggregationDefinition
  7. AbstractAggregation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TermsAggregationDefinition(name: String, field: Option[String] = None, script: Option[ScriptDefinition] = None, missing: Option[AnyRef] = None, size: Option[Int] = None, minDocCount: Option[Long] = None, showTermDocCountError: Option[Boolean] = None, valueType: Option[ValueType] = None, executionHint: Option[String] = None, shardMinDocCount: Option[Long] = None, collectMode: Option[SubAggCollectionMode] = None, _oldOrder: Option[Order] = None, order: Option[TermsOrder] = None, shardSize: Option[Int] = None, includeExclude: Option[IncludeExclude] = None, subaggs: Seq[AbstractAggregation] = Nil, metadata: Map[String, AnyRef] = Map.empty)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val _oldOrder: Option[Order]

    Permalink

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. def collectMode(mode: SubAggCollectionMode): TermsAggregationDefinition

    Permalink

  8. val collectMode: Option[SubAggCollectionMode]

    Permalink

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  10. def executionHint(hint: String): TermsAggregationDefinition

    Permalink

  11. val executionHint: Option[String]

    Permalink

  12. def field(field: String): TermsAggregationDefinition

    Permalink

  13. val field: Option[String]

    Permalink

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def includeExclude(include: Iterable[String], exclude: Iterable[String]): TermsAggregationDefinition

    Permalink

  17. def includeExclude(include: String, exclude: String): TermsAggregationDefinition

    Permalink

  18. val includeExclude: Option[IncludeExclude]

    Permalink

  19. def includeExcludeDoubles(include: Iterable[Double], exclude: Iterable[Double]): TermsAggregationDefinition

    Permalink

  20. def includeExcludeLongs(include: Iterable[Long], exclude: Iterable[Long]): TermsAggregationDefinition

    Permalink

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def metadata(map: Map[String, AnyRef]): T

    Permalink
    Definition Classes
    TermsAggregationDefinition → AbstractAggregation

  23. val metadata: Map[String, AnyRef]

    Permalink
    Definition Classes
    TermsAggregationDefinition → AbstractAggregation

  24. def minDocCount(min: Long): TermsAggregationDefinition

    Permalink

  25. val minDocCount: Option[Long]

    Permalink

  26. def missing(missing: AnyRef): TermsAggregationDefinition

    Permalink

  27. val missing: Option[AnyRef]

    Permalink

  28. val name: String

    Permalink
    Definition Classes
    TermsAggregationDefinition → AbstractAggregation

  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  32. def order(order: TermsOrder): TermsAggregationDefinition

    Permalink

  33. val order: Option[TermsOrder]

    Permalink

  34. def script(script: ScriptDefinition): TermsAggregationDefinition

    Permalink

  35. val script: Option[ScriptDefinition]

    Permalink

  36. def shardMinDocCount(min: Long): TermsAggregationDefinition

    Permalink

  37. val shardMinDocCount: Option[Long]

    Permalink

  38. def shardSize(shardSize: Int): TermsAggregationDefinition

    Permalink

  39. val shardSize: Option[Int]

    Permalink

  40. def showTermDocCountError(showError: Boolean): TermsAggregationDefinition

    Permalink

  41. val showTermDocCountError: Option[Boolean]

    Permalink

  42. def size(size: Int): TermsAggregationDefinition

    Permalink

  43. val size: Option[Int]

    Permalink

  44. def subAggregation(agg: AbstractAggregation): T

    Permalink
    Definition Classes
    AggregationDefinition

  45. def subAggregations(aggs: Iterable[AbstractAggregation]): T

    Permalink
    Definition Classes
    TermsAggregationDefinition → AggregationDefinition

  46. def subAggregations(first: AbstractAggregation, rest: AbstractAggregation*): T

    Permalink
    Definition Classes
    AggregationDefinition

  47. def subagg(agg: AbstractAggregation): T

    Permalink
    Definition Classes
    AggregationDefinition

  48. def subaggs(aggs: Iterable[AbstractAggregation]): T

    Permalink
    Definition Classes
    AggregationDefinition

  49. def subaggs(first: AbstractAggregation, rest: AbstractAggregation*): T

    Permalink
    Definition Classes
    AggregationDefinition

  50. val subaggs: Seq[AbstractAggregation]

    Permalink
    Definition Classes
    TermsAggregationDefinition → AggregationDefinition

  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  52. def valueType(valueType: ValueType): TermsAggregationDefinition

    Permalink

  53. val valueType: Option[ValueType]

    Permalink

  54. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  55. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  56. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def order(order: Order): TermsAggregationDefinition

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 5.4.1) Use order(TermsOrder) and pass in _term, _count or aggregation name

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AggregationDefinition

Inherited from AbstractAggregation

Inherited from AnyRef

Inherited from Any

Ungrouped