Package org.elasticsearch.search.aggregations.support

Enum Class ValueType

java.lang.Object
java.lang.Enum<ValueType>
org.elasticsearch.search.aggregations.support.ValueType
All Implemented Interfaces:
Serializable, Comparable<ValueType>, Constable, Writeable
@Deprecated public enum ValueType extends Enum<ValueType> implements Writeable
Deprecated.
We are in the process of replacing this class with ValuesSourceType, so new uses or entries to the enum are discouraged. There is currently no migration path for existing uses, notably parsing user value type hints and Composite aggregation, should continue to use this for now. Most importantly DO NOT ADD NEW PLACES WE SERIALIZE THIS ENUM!

  • Enum Constant Details

    • STRING

      public static final ValueType STRING
      Deprecated.

    • LONG

      public static final ValueType LONG
      Deprecated.

    • DOUBLE

      public static final ValueType DOUBLE
      Deprecated.

    • NUMBER

      public static final ValueType NUMBER
      Deprecated.

    • DATE

      public static final ValueType DATE
      Deprecated.

    • IP

      public static final ValueType IP
      Deprecated.

    • NUMERIC

      public static final ValueType NUMERIC
      Deprecated.

    • GEOPOINT

      public static final ValueType GEOPOINT
      Deprecated.

    • BOOLEAN

      public static final ValueType BOOLEAN
      Deprecated.

    • RANGE

      public static final ValueType RANGE
      Deprecated.

  • Field Details

    • VALUE_TYPE

      public static final org.elasticsearch.xcontent.ParseField VALUE_TYPE
      Deprecated.

  • Method Details

    • values

      public static ValueType[] values()
      Deprecated.
      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 ValueType valueOf(String name)
      Deprecated.
      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

    • getPreferredName

      public String getPreferredName()
      Deprecated.

    • getValuesSourceType

      public ValuesSourceType getValuesSourceType()
      Deprecated.

    • isA

      public boolean isA(ValueType valueType)
      Deprecated.
      This is a bit of a hack to mirror the old ValueType behavior, which would allow a rough compatibility between types. This behavior is being phased out in the aggregations framework, in favor of explicitly listing supported types, but we haven't gotten to fixing composite yet.
      Parameters:
      valueType - The value type the user suggested
      Returns:
      True iff the two value types are interchangeable

    • isNotA

      public boolean isNotA(ValueType valueType)
      Deprecated.

    • defaultFormat

      public DocValueFormat defaultFormat()
      Deprecated.

    • lenientParse

      public static ValueType lenientParse(String type)
      Deprecated.

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Enum<ValueType>

    • readFromStream

      public static ValueType readFromStream(StreamInput in) throws IOException
      Deprecated.
      Throws:
      IOException

    • writeTo

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