Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Enum Class PercentilesMethod

java.lang.Object

java.lang.Enum<PercentilesMethod>

org.elasticsearch.search.aggregations.metrics.PercentilesMethod

All Implemented Interfaces:

Serializable, Comparable<PercentilesMethod>, Constable, Writeable

public enum PercentilesMethod
extends Enum<PercentilesMethod>
implements Writeable

An enum representing the methods for calculating percentiles

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	COMPRESSION_FIELD
static final ObjectParser<PercentilesConfig.Hdr,String>	HDR_PARSER
static final ParseField	NUMBER_SIGNIFICANT_DIGITS_FIELD
static final ObjectParser<PercentilesConfig.TDigest,String>	TDIGEST_PARSER

Method Summary

Modifier and Type	Method	Description
ParseField	getParseField()
static PercentilesMethod	readFromStream(StreamInput in)
String	toString()
static PercentilesMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PercentilesMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

TDIGEST

public static final PercentilesMethod TDIGEST

The TDigest method for calculating percentiles

HDR

public static final PercentilesMethod HDR

The HDRHistogram method of calculating percentiles

Field Details

COMPRESSION_FIELD

public static final ParseField COMPRESSION_FIELD

NUMBER_SIGNIFICANT_DIGITS_FIELD

public static final ParseField NUMBER_SIGNIFICANT_DIGITS_FIELD

TDIGEST_PARSER

public static final ObjectParser<PercentilesConfig.TDigest,String> TDIGEST_PARSER

HDR_PARSER

public static final ObjectParser<PercentilesConfig.Hdr,String> HDR_PARSER

Method Details

values

public static PercentilesMethod[] 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 PercentilesMethod 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

getParseField

public ParseField getParseField()

Returns:

the name of the method

readFromStream

public static PercentilesMethod readFromStream(StreamInput in)
                                        throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Enum<PercentilesMethod>