Package org.elasticsearch.search.aggregations.bucket.histogram

Interface Histogram

All Superinterfaces:

Aggregation, MultiBucketsAggregation, ToXContent, ToXContentFragment

All Known Implementing Classes:

InternalAutoDateHistogram, InternalDateHistogram, InternalHistogram, InternalVariableWidthHistogram, ParsedAutoDateHistogram, ParsedDateHistogram, ParsedHistogram, ParsedVariableWidthHistogram

public interface Histogram
extends MultiBucketsAggregation

A histogram aggregation. Defines multiple buckets, each representing an interval in a histogram.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Histogram.Bucket	A bucket in the histogram where documents fall in

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	EXTENDED_BOUNDS_FIELD
static final ParseField	HARD_BOUNDS_FIELD
static final ParseField	INTERVAL_FIELD
static final ParseField	KEYED_FIELD
static final ParseField	MIN_DOC_COUNT_FIELD
static final ParseField	OFFSET_FIELD
static final ParseField	ORDER_FIELD

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
List<? extends Histogram.Bucket>	getBuckets()

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

INTERVAL_FIELD

static final ParseField INTERVAL_FIELD

OFFSET_FIELD

static final ParseField OFFSET_FIELD

ORDER_FIELD

static final ParseField ORDER_FIELD

KEYED_FIELD

static final ParseField KEYED_FIELD

MIN_DOC_COUNT_FIELD

static final ParseField MIN_DOC_COUNT_FIELD

EXTENDED_BOUNDS_FIELD

static final ParseField EXTENDED_BOUNDS_FIELD

HARD_BOUNDS_FIELD

static final ParseField HARD_BOUNDS_FIELD

Method Details

getBuckets

List<? extends Histogram.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this histogram (each bucket representing an interval in the histogram)