AggregationGroup

Types

Link copied to clipboard
data class DateHistogram(val field: QueryField, val alias: String, val unit: AggregationDateUnit, val timeZone: String = "UTC", val dense: Boolean = false) : AggregationGroup
Link copied to clipboard
data class DatePart(val field: QueryField, val alias: String, val part: AggregationDatePart, val timeZone: String = "UTC", val dense: Boolean = false) : AggregationGroup

Groups by one calendar part of the field's instant in timeZone, such as the weekday or the hour, so records from different days fall into one bucket. Keys are integers from AggregationDatePart's fixed domain; dense fills every key of that domain that has no records with the empty value of each metric.

Link copied to clipboard
data class Histogram(val field: QueryField? = null, val alias: String, val interval: Double, val expression: AggregationExpression? = null) : AggregationGroup

Buckets the numeric value of field, or of expression when the group names one instead.

Link copied to clipboard
data class Terms(val field: QueryField? = null, val alias: String, val missingKey: String? = null, val expression: AggregationExpression? = null) : AggregationGroup

Groups by the value of field, or of expression when the group names one instead.

Properties

Link copied to clipboard
abstract val alias: String
Link copied to clipboard
abstract val field: QueryField?

The grouped field; null only for a TERMS or HISTOGRAM group whose input is an expression.

Link copied to clipboard

The computed input of a TERMS or HISTOGRAM group in place of its field, or null.

Link copied to clipboard