org.elasticsearch.search.aggregations.metrics.percentiles

Enum PercentilesMethod

java.lang.Object

java.lang.Enum<PercentilesMethod>

org.elasticsearch.search.aggregations.metrics.percentiles.PercentilesMethod

All Implemented Interfaces:

Serializable, Comparable<PercentilesMethod>

public enum PercentilesMethod
extends Enum<PercentilesMethod>

An enum representing the methods for calculating percentiles

Enum Constant Summary

Enum Constants

Enum Constant and Description
HDR The HDRHistogram method of calculating percentiles
TDIGEST The TDigest method for calculating percentiles

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
static PercentilesMethod	resolveFromName(String name) Returns the PercentilesMethod for this method name.
static PercentilesMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static PercentilesMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TDIGEST

public static final PercentilesMethod TDIGEST

The TDigest method for calculating percentiles

HDR

public static final PercentilesMethod HDR

The HDRHistogram method of calculating percentiles

Method Detail

values

public static PercentilesMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PercentilesMethod c : PercentilesMethod.values())
    System.out.println(c);

Returns:

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

valueOf

public static PercentilesMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Returns:

the name of the method

resolveFromName

public static PercentilesMethod resolveFromName(String name)

Returns the PercentilesMethod for this method name. returns null if no PercentilesMethod exists for the name.