com.arakelian.elastic.model.aggs.bucket

Interface DateHistogramAggregation

All Superinterfaces:

Aggregation, BucketAggregation, java.io.Serializable, ValuesSourceAggregation

@Value.Immutable(copy=false)
public interface DateHistogramAggregation
extends BucketAggregation, ValuesSourceAggregation

A multi-bucket aggregation similar to @{link HistogramAggregation} except it can only be applied on date values.

Since dates are represented in Elasticsearch internally as long values, it is possible to use the normal histogram on dates as well, though accuracy will be compromised. The reason for this is in the fact that time based intervals are not fixed (think of leap years and on the number of days in a month). For this reason, we need special support for time based data.

From a functionality perspective, this histogram supports the same features as the normal histogram. The main difference is that the interval can be specified by date/time expressions.

See Also:

Date Histogram Aggregation, DateHistogramAggregationBuilder.java

Field Summary

Fields inherited from interface com.arakelian.elastic.model.aggs.Aggregation

ADJACENCY_MATRIX_AGGREGATION, AVG_AGGREGATION, CARDINALITY_AGGREGATION, DATE_HISTOGRAM_AGGREGATION, DATE_RANGE_AGGREGATION, EXTENDED_STATS_AGGREGATION, FILTER_AGGREGATION, FILTERS_AGGREGATION, GEO_BOUNDS_AGGREGATION, GEO_CENTROID_AGGREGATION, GEO_DISTANCE_AGGREGATION, GEOHASH_GRID_AGGREGATION, GLOBAL_AGGREGATION, HISTOGRAM_AGGREGATION, IP_RANGE_AGGREGATION, MAX_AGGREGATION, MIN_AGGREGATION, MISSING_AGGREGATION, NESTED_AGGREGATION, PERCENTILE_RANKS_AGGREGATION, PERCENTILES_AGGREGATION, RANGE_AGGREGATION, REVERSE_NESTED_AGGREGATION, SAMPLER_AGGREGATION, SIGNIFICANT_TERMS_AGGREGATION, SIGNIFICANT_TEXT_AGGREGATION, STATS_AGGREGATION, SUM_AGGREGATION, TERMS_AGGREGATION, VALUE_COUNT_AGGREGATION

Method Summary

Modifier and Type	Method and Description
default void	accept(AggregationVisitor visitor)
java.lang.Long	getExtendedBoundsMax()
java.lang.Long	getExtendedBoundsMin()
java.lang.String	getInterval()
java.lang.Long	getMinDocCount() Returns the minimum number of hits required before returning a term.
java.lang.Long	getOffset()
default java.util.List<BucketOrder>	getOrder() Returns the bucket order.
java.lang.Boolean	isKeyed()

Methods inherited from interface com.arakelian.elastic.model.aggs.Aggregation

countNotEmpty, getName, getSubAggregations, isEmpty

Methods inherited from interface com.arakelian.elastic.model.aggs.ValuesSourceAggregation

getField, getFormat, getMissing, getTimeZone

Method Detail

getExtendedBoundsMax

java.lang.Long getExtendedBoundsMax()

getExtendedBoundsMin

java.lang.Long getExtendedBoundsMin()

getInterval

java.lang.String getInterval()

getMinDocCount

java.lang.Long getMinDocCount()

Returns the minimum number of hits required before returning a term.

Returns:

the minimum number of hits required before returning a term.

getOffset

java.lang.Long getOffset()

getOrder

@Value.Default
default java.util.List<BucketOrder> getOrder()

Returns the bucket order.

Returns:

the bucket order

See Also:

InternalOrder.java

isKeyed

java.lang.Boolean isKeyed()

accept

default void accept(AggregationVisitor visitor)

Specified by:

accept in interface Aggregation