Package org.opensearch.search.aggregations.bucket.histogram

Interface Histogram

All Superinterfaces:
Aggregation, MultiBucketsAggregation, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.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.opensearch.search.aggregations.Aggregation

    Aggregation.CommonFields

    Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

    org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.opensearch.common.ParseField EXTENDED_BOUNDS_FIELD  
    static org.opensearch.common.ParseField HARD_BOUNDS_FIELD  
    static org.opensearch.common.ParseField INTERVAL_FIELD  
    static org.opensearch.common.ParseField KEYED_FIELD  
    static org.opensearch.common.ParseField MIN_DOC_COUNT_FIELD  
    static org.opensearch.common.ParseField OFFSET_FIELD  
    static org.opensearch.common.ParseField ORDER_FIELD  

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

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.opensearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

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

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

    getMetadata, getName, getType

    Methods inherited from interface org.opensearch.common.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

    isFragment