Enum AlertTopic

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AlertTopic>

    public enum AlertTopic
    extends java.lang.Enum<AlertTopic>
    A collection of alert topics used to categorize Alerts sent by the MetricStreamJoiner.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JOIN_SCRIPT_FAILURE
      Alert topic indicating that the join script failed to produce a proper result.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getTopicPath()
      Returns the topic path of this AlertTopic, which is used to indicate what part of the system this Alert stems from.
      static AlertTopic valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AlertTopic[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • JOIN_SCRIPT_FAILURE

        public static final AlertTopic JOIN_SCRIPT_FAILURE
        Alert topic indicating that the join script failed to produce a proper result.
    • Method Detail

      • values

        public static AlertTopic[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AlertTopic c : AlertTopic.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AlertTopic 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
      • getTopicPath

        public java.lang.String getTopicPath()
        Returns the topic path of this AlertTopic, which is used to indicate what part of the system this Alert stems from.
        Returns: