Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Enum Class TimeSeriesParams.MetricType

java.lang.Object

java.lang.Enum<TimeSeriesParams.MetricType>

org.elasticsearch.index.mapper.TimeSeriesParams.MetricType

All Implemented Interfaces:

Serializable, Comparable<TimeSeriesParams.MetricType>, Constable

Enclosing class:

TimeSeriesParams

public static enum TimeSeriesParams.MetricType
extends Enum<TimeSeriesParams.MetricType>

There are various types of metric used in time-series aggregations and downsampling. Each supports different field types and different calculations. Two of these, the COUNTER and GAUGE apply to most numerical types, mapping a single number, while the POSITION metric applies only to geo_point and therefor a pair of numbers (lat,lon). To simplify code that depends on this difference, we use the parameter `scalar==true` for single number metrics, and `false` for the POSITION metric.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COUNTER
GAUGE
POSITION

Method Summary

Modifier and Type	Method	Description
static TimeSeriesParams.MetricType	fromString(String value)
static TimeSeriesParams.MetricType[]	scalar()	an array of metrics representing simple numerical values, like GAUGE and COUNTER
String[]	supportedAggs()	list of aggregations supported for downsampling this metric
final String	toString()
static TimeSeriesParams.MetricType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimeSeriesParams.MetricType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GAUGE

public static final TimeSeriesParams.MetricType GAUGE

COUNTER

public static final TimeSeriesParams.MetricType COUNTER

POSITION

public static final TimeSeriesParams.MetricType POSITION

Method Details

values

public static TimeSeriesParams.MetricType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TimeSeriesParams.MetricType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

supportedAggs

public String[] supportedAggs()

list of aggregations supported for downsampling this metric

scalar

public static TimeSeriesParams.MetricType[] scalar()

an array of metrics representing simple numerical values, like GAUGE and COUNTER

toString

public final String toString()

Overrides:

toString in class Enum<TimeSeriesParams.MetricType>

fromString

public static TimeSeriesParams.MetricType fromString(String value)