Package io.muserver

Enum RateLimitRejectionAction

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      IGNORE
      Nothing happens except the event is logged.
      SEND_429
      An HTTP 429 response is sent to the client
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static RateLimitRejectionAction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RateLimitRejectionAction[] 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

      • IGNORE

        public static final RateLimitRejectionAction IGNORE
        Nothing happens except the event is logged. Useful to detect when a rate limit would be exceeded for a given system without causing any impact.
    • Method Detail

      • values

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

        public static RateLimitRejectionAction 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