Package org.hawaiiframework.logging.model

Enum Class KibanaLogFieldNames

java.lang.Object
java.lang.Enum<KibanaLogFieldNames>
org.hawaiiframework.logging.model.KibanaLogFieldNames
All Implemented Interfaces:
Serializable, Comparable<KibanaLogFieldNames>, Constable, KibanaLogField
public enum KibanaLogFieldNames extends Enum<KibanaLogFieldNames> implements KibanaLogField
This enum represents keys for data that is stored in the logging MDC.
Since:
2.0.0

  • Enum Constant Details

  • Method Details

    • values

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

    • getLogName

      public String getLogName()
      Description copied from interface: KibanaLogField
      Get the name with which this field will appear in the log.
      Specified by:
      getLogName in interface KibanaLogField
      Returns:
      the log name of the field

    • fromKey

      public static KibanaLogFieldNames fromKey(String key)
      Lookup method that does not throw an exception if the specified key is not found.
      Parameters:
      key - the key to look for
      Returns:
      the MdcKey with the given name, or null