query-api/me.ahoo.wow.api.query/AggregationGroup/Terms

Terms

class Terms @InternalWowApi constructor(val field: QueryField<*>? = null, val alias: String, val missingKey: String? = null, val expression: AggregationExpression? = null, val scope: AggregationGroupScope? = null) : AggregationGroup

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

Constructors

Terms

@InternalWowApi

constructor(field: QueryField<*>? = null, alias: String, missingKey: String? = null, expression: AggregationExpression? = null, scope: AggregationGroupScope? = null)

Types

Companion

object Companion

Properties

alias

open override val alias: String

expression

val expression: AggregationExpression?

field

open override val field: QueryField<*>?

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

missingKey

val missingKey: String?

scope

open override val scope: AggregationGroupScope?

Where field is read when the query expands elements: null (the innermost element, relative to its container) or AggregationGroupScope.ROOT (a root field, by its absolute path), so a count of elements can be grouped by a field of the record they belong to, such as its creation day. Without elements both read the root.

Functions

copy

@InternalWowApi

fun copy(field: QueryField<*>? = this.field, alias: String = this.alias, missingKey: String? = this.missingKey, expression: AggregationExpression? = this.expression, scope: AggregationGroupScope? = this.scope): AggregationGroup.Terms

This Terms with the given values replaced; for Wow's own query rewriting.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String