Class DateHistogramInterval
java.lang.Object
org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public class DateHistogramInterval extends java.lang.Object implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
The interval the date histogram is based on.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static DateHistogramInterval
DAY
static DateHistogramInterval
HOUR
static DateHistogramInterval
MINUTE
static DateHistogramInterval
MONTH
static DateHistogramInterval
QUARTER
static DateHistogramInterval
SECOND
static DateHistogramInterval
WEEK
static DateHistogramInterval
YEAR
-
Constructor Summary
Constructors Constructor Description DateHistogramInterval(java.lang.String expression)
DateHistogramInterval(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description static DateHistogramInterval
days(int days)
boolean
equals(java.lang.Object obj)
long
estimateMillis()
Converts this DateHistogramInterval into a millisecond representation.int
hashCode()
static DateHistogramInterval
hours(int hours)
static DateHistogramInterval
minutes(int min)
static DateHistogramInterval
seconds(int sec)
java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
static DateHistogramInterval
weeks(int weeks)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
Constructor Details
-
DateHistogramInterval
public DateHistogramInterval(java.lang.String expression) -
DateHistogramInterval
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
seconds
-
minutes
-
hours
-
days
-
weeks
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.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.
-