Module org.elasticsearch.server
Class DateHistogramInterval
java.lang.Object
org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
The interval the date histogram is based on.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DateHistogramIntervalstatic final DateHistogramIntervalstatic final DateHistogramIntervalstatic final DateHistogramIntervalstatic final DateHistogramIntervalstatic final DateHistogramIntervalstatic final DateHistogramIntervalstatic final DateHistogramIntervalFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DateHistogramIntervaldays(int days) booleanlongConverts this DateHistogramInterval into a millisecond representation.inthashCode()static DateHistogramIntervalhours(int hours) static DateHistogramIntervalminutes(int min) static DateHistogramIntervalseconds(int sec) toString()toXContent(XContentBuilder builder, ToXContent.Params params) static DateHistogramIntervalweeks(int weeks) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
SECOND
-
MINUTE
-
HOUR
-
DAY
-
WEEK
-
MONTH
-
QUARTER
-
YEAR
-
-
Constructor Details
-
DateHistogramInterval
-
DateHistogramInterval
Read from a stream.- Throws:
IOException
-
-
Method Details
-
seconds
-
minutes
-
hours
-
days
-
weeks
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toString
-
hashCode
public int hashCode() -
equals
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
estimateMillis
public long estimateMillis()Converts this DateHistogramInterval into a millisecond representation. If this is a calendar interval, it is an approximation of milliseconds based on the fixed equivalent (e.g. `1h` is treated as 60 fixed minutes, rather than the hour at a specific point in time. This is merely a convenience helper for quick comparisons and should not be used for situations that require precise durations.
-