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

  • Enum Constant Details

    • TDIGEST

      public static final PercentilesMethod TDIGEST
      The TDigest method for calculating percentiles

      The TDigest and TDIGEST names have been deprecated since 8.0, but we don't have any plans to remove it so we don't break anyone using it.

    • HDR

      public static final PercentilesMethod HDR
      The HDRHistogram method of calculating percentiles

      The HDR name has been deprecated since 8.0, but we don't have any plans to remove it so we don't break anyone using it.

  • Field Details

  • 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>