Enum Frequency

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

    public enum Frequency
    extends java.lang.Enum<Frequency>
    Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). Supported for CategoryType(s): ReservationUtilization.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Daily
      After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day.
      Monthly
      After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days.
      Weekly
      After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getValue()  
      java.lang.String toString()  
      static Frequency valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Frequency[] 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, valueOf
      • Methods inherited from class java.lang.Object

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

      • Daily

        public static final Frequency Daily
        After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day.
      • Weekly

        public static final Frequency Weekly
        After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days.
      • Monthly

        public static final Frequency Monthly
        After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days.
    • Method Detail

      • values

        public static Frequency[] 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 (Frequency c : Frequency.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Frequency 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
      • getValue

        public java.lang.String getValue()
      • toString

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