Package org.elasticsearch.common.logging

Enum DeprecationCategory

java.lang.Object
java.lang.Enum<DeprecationCategory>
org.elasticsearch.common.logging.DeprecationCategory
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DeprecationCategory>, java.lang.constant.Constable
public enum DeprecationCategory
extends java.lang.Enum<DeprecationCategory>
Deprecation log messages are categorised so that consumers of the logs can easily aggregate them.

When categorising a message, you should consider the impact of the work required to mitigate the deprecation. For example, a settings change would normally be categorised as SETTINGS, but if the setting in question was related to security configuration, it may be more appropriate to categorise the deprecation message as SECURITY.

  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    AGGREGATIONS  
    ANALYSIS  
    API  
    INDICES  
    MAPPINGS  
    OTHER  
    PARSING  
    PLUGINS  
    QUERIES  
    SCRIPTING  
    SECURITY  
    SETTINGS  
    TEMPLATES  
    TYPES  

  • Method Summary

    Modifier and Type Method Description
    static DeprecationCategory valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static DeprecationCategory[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

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