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

Class DateHistogramInterval

java.lang.Object

org.opensearch.search.aggregations.bucket.histogram.DateHistogramInterval

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class DateHistogramInterval
extends java.lang.Object
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

The interval the date histogram is based on.

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.opensearch.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

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

EMPTY_PARAMS

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.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
static DateHistogramInterval	weeks(int weeks)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isFragment

Field Details

SECOND

public static final DateHistogramInterval SECOND

MINUTE

public static final DateHistogramInterval MINUTE

HOUR

public static final DateHistogramInterval HOUR

DAY

public static final DateHistogramInterval DAY

WEEK

public static final DateHistogramInterval WEEK

MONTH

public static final DateHistogramInterval MONTH

QUARTER

public static final DateHistogramInterval QUARTER

YEAR

public static final DateHistogramInterval YEAR

Constructor Details

DateHistogramInterval

public DateHistogramInterval(java.lang.String expression)

DateHistogramInterval

public DateHistogramInterval(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

seconds

public static DateHistogramInterval seconds(int sec)

minutes

public static DateHistogramInterval minutes(int min)

hours

public static DateHistogramInterval hours(int hours)

days

public static DateHistogramInterval days(int days)

weeks

public static DateHistogramInterval weeks(int weeks)

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.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.