Package org.elasticsearch.search.aggregations.bucket.composite

Class DateHistogramValuesSourceBuilder

java.lang.Object

org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

org.elasticsearch.search.aggregations.bucket.composite.DateHistogramValuesSourceBuilder

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, DateIntervalConsumer

public class DateHistogramValuesSourceBuilder
extends CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>
implements DateIntervalConsumer

A CompositeValuesSourceBuilder that builds a RoundingValuesSource from a Script or a field name using the provided interval.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DateHistogramValuesSourceBuilder.DateHistogramCompositeSupplier

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 inherited from class org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	DateHistogramValuesSourceBuilder(java.lang.String name)
protected	DateHistogramValuesSourceBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
DateHistogramValuesSourceBuilder	calendarInterval(DateHistogramInterval interval)	Sets the interval of the DateHistogram using calendar units (`1d`, `1w`, `1M`, etc).
DateHistogramInterval	dateHistogramInterval()	Deprecated.
DateHistogramValuesSourceBuilder	dateHistogramInterval(DateHistogramInterval interval)	Deprecated. Use calendarInterval(DateHistogramInterval) or fixedInterval(DateHistogramInterval) instead
protected void	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean	equals(java.lang.Object obj)
DateHistogramValuesSourceBuilder	fixedInterval(DateHistogramInterval interval)	Sets the interval of the DateHistogram using fixed units (`1ms`, `1s`, `10m`, `4h`, etc).
protected ValuesSourceType	getDefaultValuesSourceType()
DateHistogramInterval	getIntervalAsCalendar()	Return the interval as a date time unit if applicable, regardless of how it was configured.
DateHistogramInterval	getIntervalAsFixed()	Get the interval as a TimeValue, regardless of how it was configured.
int	hashCode()
protected CompositeValuesSourceConfig	innerBuild(ValuesSourceRegistry registry, ValuesSourceConfig config)	Actually build the values source and its associated configuration.
protected void	innerWriteTo(StreamOutput out)
long	interval()	Deprecated.
DateHistogramValuesSourceBuilder	interval(long interval)	Deprecated. Use calendarInterval(DateHistogramInterval) or fixedInterval(DateHistogramInterval) instead
long	offset()	Get the offset to use when rounding, which is a number of milliseconds.
DateHistogramValuesSourceBuilder	offset(long offset)	Set the offset on this builder, which is a number of milliseconds.
static void	register(ValuesSourceRegistry.Builder builder)
java.time.ZoneId	timeZone()	Gets the time zone to use for this aggregation
DateHistogramValuesSourceBuilder	timeZone(java.time.ZoneId timeZone)	Sets the time zone to use for this aggregation
java.lang.String	type()

Methods inherited from class org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

build, field, field, format, format, missingBucket, missingBucket, name, order, order, order, script, script, toXContent, userValuetypeHint, userValuetypeHint, writeTo

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Details

DateHistogramValuesSourceBuilder

public DateHistogramValuesSourceBuilder(java.lang.String name)

DateHistogramValuesSourceBuilder

protected DateHistogramValuesSourceBuilder(StreamInput in)
                                    throws java.io.IOException

Throws:

java.io.IOException

Method Details

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws java.io.IOException

Specified by:

innerWriteTo in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

Throws:

java.io.IOException

doXContentBody

protected void doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder,
org.elasticsearch.common.xcontent.ToXContent.Params params)
                       throws java.io.IOException

Specified by:

doXContentBody in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

type

public java.lang.String type()

interval

@Deprecated
public long interval()

Deprecated.

Returns the interval in milliseconds that is set on this source

Specified by:

interval in interface DateIntervalConsumer

interval

@Deprecated
public DateHistogramValuesSourceBuilder interval(long interval)

Deprecated.

Use calendarInterval(DateHistogramInterval) or fixedInterval(DateHistogramInterval) instead

Sets the interval on this source. If both interval() and dateHistogramInterval() are set, then the dateHistogramInterval() wins.

Specified by:

interval in interface DateIntervalConsumer

Since:

7.2.0

dateHistogramInterval

@Deprecated
public DateHistogramInterval dateHistogramInterval()

Deprecated.

Returns the date interval that is set on this source

Specified by:

dateHistogramInterval in interface DateIntervalConsumer

dateHistogramInterval

@Deprecated
public DateHistogramValuesSourceBuilder dateHistogramInterval(DateHistogramInterval interval)

Deprecated.

Use calendarInterval(DateHistogramInterval) or fixedInterval(DateHistogramInterval) instead

Specified by:

dateHistogramInterval in interface DateIntervalConsumer

Since:

7.2.0

calendarInterval

public DateHistogramValuesSourceBuilder calendarInterval(DateHistogramInterval interval)

Sets the interval of the DateHistogram using calendar units (`1d`, `1w`, `1M`, etc). These units are calendar-aware, meaning they respect leap additions, variable days per month, etc. This is mutually exclusive with fixedInterval(DateHistogramInterval)

Specified by:

calendarInterval in interface DateIntervalConsumer

Parameters:

interval - The calendar interval to use with the aggregation

fixedInterval

public DateHistogramValuesSourceBuilder fixedInterval(DateHistogramInterval interval)

Sets the interval of the DateHistogram using fixed units (`1ms`, `1s`, `10m`, `4h`, etc). These are not calendar aware and are simply multiples of fixed, SI units. This is mutually exclusive with calendarInterval(DateHistogramInterval)

Specified by:

fixedInterval in interface DateIntervalConsumer

Parameters:

interval - The fixed interval to use with the aggregation

getIntervalAsCalendar

public DateHistogramInterval getIntervalAsCalendar()

Return the interval as a date time unit if applicable, regardless of how it was configured. If this returns null then it means that the interval is expressed as a fixed TimeValue and may be accessed via getIntervalAsFixed() ()}.

getIntervalAsFixed

public DateHistogramInterval getIntervalAsFixed()

Get the interval as a TimeValue, regardless of how it was configured. Returns null if the interval cannot be parsed as a fixed time.

timeZone

public DateHistogramValuesSourceBuilder timeZone(java.time.ZoneId timeZone)

Sets the time zone to use for this aggregation

timeZone

public java.time.ZoneId timeZone()

Gets the time zone to use for this aggregation

Overrides:

timeZone in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

offset

public long offset()

Get the offset to use when rounding, which is a number of milliseconds.

offset

public DateHistogramValuesSourceBuilder offset(long offset)

Set the offset on this builder, which is a number of milliseconds.

Returns:

this for chaining

register

public static void register(ValuesSourceRegistry.Builder builder)

getDefaultValuesSourceType

protected ValuesSourceType getDefaultValuesSourceType()

Specified by:

getDefaultValuesSourceType in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

innerBuild

protected CompositeValuesSourceConfig innerBuild(ValuesSourceRegistry registry,
ValuesSourceConfig config)
                                          throws java.io.IOException

Description copied from class: CompositeValuesSourceBuilder

Actually build the values source and its associated configuration.

Specified by:

innerBuild in class CompositeValuesSourceBuilder<DateHistogramValuesSourceBuilder>

Throws:

java.io.IOException