com.arakelian.elastic.model.aggs.bucket

Interface BucketOrder

All Superinterfaces:

java.io.Serializable

@Value.Immutable(copy=false)
public interface BucketOrder
extends java.io.Serializable

Field Summary

Fields

Modifier and Type	Field and Description
static BucketOrder	COUNT_ASC
static BucketOrder	COUNT_DESC
static BucketOrder	KEY_ASC
static BucketOrder	KEY_DESC

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldName() Returns the field to sort by.
default SortOrder	getOrder()
static BucketOrder	of(java.lang.String name)
static BucketOrder	of(java.lang.String name, SortOrder order)

Field Detail

KEY_ASC

static final BucketOrder KEY_ASC

KEY_DESC

static final BucketOrder KEY_DESC

COUNT_ASC

static final BucketOrder COUNT_ASC

COUNT_DESC

static final BucketOrder COUNT_DESC

Method Detail

of

static BucketOrder of(java.lang.String name)

of

static BucketOrder of(java.lang.String name,
                      SortOrder order)

getFieldName

java.lang.String getFieldName()

Returns the field to sort by.

• The field names _term and _time are deprecated, but synonymous with reserved field name _key which orders the buckets alphabetically by term.
• The field name _count is reserved and order the buckets by their document count
• Any other field name is are sorting on a sub-aggregation

Returns:

the field to sort by

See Also:

InternalOrder.java

getOrder

@Value.Default
default SortOrder getOrder()