Enum Class ThrottleReason

java.lang.Object
java.lang.Enum<ThrottleReason>
org.apache.kafka.server.quota.ThrottleReason
All Implemented Interfaces:
Serializable, Comparable<ThrottleReason>, Constable
public enum ThrottleReasonextends Enum<ThrottleReason>
Internal throttle reasons reported by the QuotaCoordinator.

These represent the coordinator's determination of why a quota entity is being throttled. On the broker side, these are mapped to customer-facing reasons via ClientQuotaCallback.mapThrottleReason(ThrottleReason, java.util.Map).

  • Enum Constant Details

    • SKEW_TRAFFIC

      public static final ThrottleReason SKEW_TRAFFIC
      Throttling occurred despite low cluster-wide usage (traffic skew / partition hotspot).

    • TOTAL_QUOTA_EXCEEDED

      public static final ThrottleReason TOTAL_QUOTA_EXCEEDED
      The cluster-wide (tenant's or principal's) quota limit was exceeded.

    • BROKER_CAPACITY_REACHED

      public static final ThrottleReason BROKER_CAPACITY_REACHED
      A broker hit its per-broker capacity cap while the entity was being throttled.

    • SCALING_OUT

      public static final ThrottleReason SCALING_OUT
      Throttling occurred while the cluster quota is scaling out (eCKU scaling).

  • Method Details

    • values

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

    • value

      public String value()
      Returns the wire-format string sent in PublishQuotaTargetRequest.

    • fromValue

      public static ThrottleReason fromValue(String value)
      Parses a wire-format string into a ThrottleReason.
      Parameters:
      value - the string value from the protocol
      Returns:
      the matching enum constant, or null if unrecognized