Enum PercentilesMethod

java.lang.Object
java.lang.Enum<PercentilesMethod>
org.elasticsearch.search.aggregations.metrics.PercentilesMethod
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PercentilesMethod>, java.lang.constant.Constable, Writeable

public enum PercentilesMethod
extends java.lang.Enum<PercentilesMethod>
implements Writeable
An enum representing the methods for calculating percentiles
  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.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 org.elasticsearch.common.ParseField COMPRESSION_FIELD  
    static org.elasticsearch.common.xcontent.ObjectParser<PercentilesConfig.Hdr,​java.lang.String> HDR_PARSER  
    static org.elasticsearch.common.ParseField NUMBER_SIGNIFICANT_DIGITS_FIELD  
    static org.elasticsearch.common.xcontent.ObjectParser<PercentilesConfig.TDigest,​java.lang.String> TDIGEST_PARSER  
  • Method Summary

    Modifier and Type Method Description
    org.elasticsearch.common.ParseField getParseField()  
    static PercentilesMethod readFromStream​(StreamInput in)  
    java.lang.String toString()  
    static PercentilesMethod valueOf​(java.lang.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.
    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 org.elasticsearch.common.ParseField COMPRESSION_FIELD
    • NUMBER_SIGNIFICANT_DIGITS_FIELD

      public static final org.elasticsearch.common.ParseField NUMBER_SIGNIFICANT_DIGITS_FIELD
    • TDIGEST_PARSER

      public static final org.elasticsearch.common.xcontent.ObjectParser<PercentilesConfig.TDigest,​java.lang.String> TDIGEST_PARSER
    • HDR_PARSER

      public static final org.elasticsearch.common.xcontent.ObjectParser<PercentilesConfig.Hdr,​java.lang.String> HDR_PARSER
  • Method Details

    • values

      public static PercentilesMethod[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static PercentilesMethod valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
    • getParseField

      public org.elasticsearch.common.ParseField getParseField()
      Returns:
      the name of the method
    • readFromStream

      public static PercentilesMethod readFromStream​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Enum<PercentilesMethod>