Class

com.sksamuel.elastic4s.searches.aggs

TermsAggregation

Related Doc: package aggs

Permalink

case class TermsAggregation(name: String, field: Option[String] = None, script: Option[Script] = 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, orders: Seq[TermsOrder] = Nil, shardSize: Option[Int] = None, includeExclude: Option[IncludeExclude] = None, includePartition: Option[IncludePartition] = None, subaggs: Seq[AbstractAggregation] = Nil, metadata: Map[String, AnyRef] = Map.empty) extends Aggregation with Product with Serializable

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

Instance Constructors

  1. new TermsAggregation(name: String, field: Option[String] = None, script: Option[Script] = 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, orders: Seq[TermsOrder] = Nil, shardSize: Option[Int] = None, includeExclude: Option[IncludeExclude] = None, includePartition: Option[IncludePartition] = None, subaggs: Seq[AbstractAggregation] = Nil, metadata: Map[String, AnyRef] = Map.empty)

    Permalink

Type Members

  1. type T = TermsAggregation

    Permalink
    Definition Classes
    TermsAggregation → AbstractAggregation

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. def addSubAggregation(agg: AbstractAggregation): T

    Permalink
    Definition Classes
    Aggregation

  5. def addSubagg(agg: AbstractAggregation): T

    Permalink
    Definition Classes
    Aggregation

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def collectMode(mode: SubAggCollectionMode): TermsAggregation

    Permalink

  9. val collectMode: Option[SubAggCollectionMode]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  11. def exclude(excludes: Seq[String]): TermsAggregation

    Permalink

  12. def exclude(exclude: String): TermsAggregation

    Permalink

  13. def excludes: Seq[String]

    Permalink

  14. def executionHint(hint: String): TermsAggregation

    Permalink

  15. val executionHint: Option[String]

    Permalink

  16. def field(field: String): TermsAggregation

    Permalink

  17. val field: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  19. def include(includes: Seq[String]): TermsAggregation

    Permalink

  20. def include(include: String): TermsAggregation

    Permalink

  21. def includeExclude(include: Iterable[String], exclude: Iterable[String]): TermsAggregation

    Permalink

  22. def includeExclude(include: String, exclude: String): TermsAggregation

    Permalink

  23. val includeExclude: Option[IncludeExclude]

    Permalink

  24. def includePartition(partition: Int, numPartitions: Int): TermsAggregation

    Permalink

  25. val includePartition: Option[IncludePartition]

    Permalink

  26. def includes: Seq[String]

    Permalink

  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    TermsAggregation → AbstractAggregation

  29. val metadata: Map[String, AnyRef]

    Permalink
    Definition Classes
    TermsAggregation → AbstractAggregation

  30. def minDocCount(min: Long): TermsAggregation

    Permalink

  31. val minDocCount: Option[Long]

    Permalink

  32. def missing(missing: AnyRef): TermsAggregation

    Permalink

  33. val missing: Option[AnyRef]

    Permalink

  34. val name: String

    Permalink
    Definition Classes
    TermsAggregation → AbstractAggregation

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

    Permalink
    Definition Classes
    AnyRef

  36. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  37. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  38. def order(firstOrder: TermsOrder, restOrder: TermsOrder*): TermsAggregation

    Permalink

  39. def order(orders: Iterable[TermsOrder]): TermsAggregation

    Permalink

  40. val orders: Seq[TermsOrder]

    Permalink

  41. def script(script: Script): TermsAggregation

    Permalink

  42. val script: Option[Script]

    Permalink

  43. def shardMinDocCount(min: Long): TermsAggregation

    Permalink

  44. val shardMinDocCount: Option[Long]

    Permalink

  45. def shardSize(shardSize: Int): TermsAggregation

    Permalink

  46. val shardSize: Option[Int]

    Permalink

  47. def showTermDocCountError(showError: Boolean): TermsAggregation

    Permalink

  48. val showTermDocCountError: Option[Boolean]

    Permalink

  49. def size(size: Int): TermsAggregation

    Permalink

  50. val size: Option[Int]

    Permalink

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

    Permalink
    Definition Classes
    TermsAggregation → Aggregation

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

    Permalink
    Definition Classes
    Aggregation

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

    Permalink
    Definition Classes
    Aggregation

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

    Permalink
    Definition Classes
    Aggregation

  55. val subaggs: Seq[AbstractAggregation]

    Permalink
    Definition Classes
    TermsAggregation → Aggregation

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

    Permalink
    Definition Classes
    AnyRef

  57. def valueType(valueType: ValueType): TermsAggregation

    Permalink

  58. val valueType: Option[ValueType]

    Permalink

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

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

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

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

  61. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Aggregation

Inherited from AbstractAggregation

Inherited from AnyRef

Inherited from Any

Ungrouped