Package lumis.portal.bigdata.query

Class DateHistogramAggregation.Interval

java.lang.Object

lumis.portal.bigdata.query.DateHistogramAggregation.Interval

Enclosing class:

DateHistogramAggregation

public static class DateHistogramAggregation.Interval
extends java.lang.Object

Date histogram interval.

Since:

11.0.0

Version:

$Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateHistogramAggregation.Interval.Type	Interval type.

Field Summary

Fields

Modifier and Type	Field	Description
static DateHistogramAggregation.Interval	DAY	Interval of 1 day.
static DateHistogramAggregation.Interval	HOUR	Interval of 1 hour.
static DateHistogramAggregation.Interval	MINUTE	Interval of 1 minute.
static DateHistogramAggregation.Interval	MONTH	Interval of 1 month.
static DateHistogramAggregation.Interval	QUARTER	Interval of 1 quarter.
static DateHistogramAggregation.Interval	SECOND	Interval of 1 second.
static DateHistogramAggregation.Interval	WEEK	Interval of 1 week.
static DateHistogramAggregation.Interval	YEAR	Interval of 1 year.

Method Summary

Modifier and Type	Method	Description
static DateHistogramAggregation.Interval	custom(long amount, DateHistogramAggregation.Interval.Type type)	Creates a new custom interval.
long	getAmount()	Returns the amount.
DateHistogramAggregation.Interval.Type	getType()	Returns the type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SECOND

public static final DateHistogramAggregation.Interval SECOND

Interval of 1 second.

Since:

11.0.0

MINUTE

public static final DateHistogramAggregation.Interval MINUTE

Interval of 1 minute.

Since:

11.0.0

HOUR

public static final DateHistogramAggregation.Interval HOUR

Interval of 1 hour.

Since:

11.0.0

DAY

public static final DateHistogramAggregation.Interval DAY

Interval of 1 day.

Since:

11.0.0

WEEK

public static final DateHistogramAggregation.Interval WEEK

Interval of 1 week.

Since:

11.0.0

MONTH

public static final DateHistogramAggregation.Interval MONTH

Interval of 1 month.

Since:

11.0.0

QUARTER

public static final DateHistogramAggregation.Interval QUARTER

Interval of 1 quarter.

Since:

11.0.0

YEAR

public static final DateHistogramAggregation.Interval YEAR

Interval of 1 year.

Since:

11.0.0

Method Detail

getAmount

public long getAmount()

Returns the amount.

Returns:

the amount

Since:

11.0.0

getType

public DateHistogramAggregation.Interval.Type getType()

Returns the type.

Returns:

the type

Since:

11.0.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

custom

public static DateHistogramAggregation.Interval custom(long amount,
                                                       DateHistogramAggregation.Interval.Type type)

Creates a new custom interval.

Parameters:

amount -

type -

Returns:

Throws:

java.lang.IllegalArgumentException - if type is one of MONTH, QUARTER, WEEK, YEAR and amount is not 1.

Since:

11.0.0