Class DateHistogramAggregation

    • Field Detail

      • id

        protected final String id
    • Constructor Detail

      • DateHistogramAggregation

        public DateHistogramAggregation​(String id,
                                        DocumentTypeField field)
        Creates a new instance.
        Parameters:
        id - the aggregation identifier.
        field - the field this aggregation will be performed on.
        Since:
        11.0.0
    • Method Detail

      • getInterval

        public I getInterval()
        Returns the interval.
        Returns:
        the interval
        Since:
        11.0.0
      • setInterval

        public void setInterval​(I interval)
        Sets the interval.
        Parameters:
        interval - the interval value to set.
        Since:
        11.0.0
      • getOffset

        public I getOffset()
        Returns the offset.
        Returns:
        the offset
        Since:
        11.0.0
      • setOffset

        public void setOffset​(I offset)
        Sets the offset.
        Parameters:
        offset - the offset value to set.
        Since:
        11.0.0
      • setExtendedBounds

        public void setExtendedBounds​(B lowerBound,
                                      B upperBound)
        Sets the extended bounds.
        lowerBound and upperBound must be both not null or both null. When a histogram aggregation has a lower and upper bounds, the histogram will return buckets for the given limits, even if no documents fill a given interval bucket.
        Parameters:
        lowerBound - the lower limit.
        upperBound - the upper limit.
        Since:
        11.0.0
      • getLowerBound

        public B getLowerBound()
        Returns the lowerBound.
        Returns:
        the lowerBound
        Since:
        11.0.0
      • getUpperBound

        public B getUpperBound()
        Returns the upperBound.
        Returns:
        the upperBound
        Since:
        11.0.0
      • getId

        public String getId()
        Description copied from interface: IAggregation
        Returns the aggregation identifier.
        Specified by:
        getId in interface IAggregation
        Returns:
        the aggregation identifier.