Package io.github.resilience4j.circuitbreaker

Enum CircuitBreaker.State

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLOSED
      A CLOSED breaker is operating normally and allowing requests through.
      DISABLED
      A DISABLED breaker is not operating (no state transition, no events) and allowing all requests through.
      FORCED_OPEN
      A FORCED_OPEN breaker is not operating (no state transition, no events) and not allowing any requests through.
      HALF_OPEN
      A HALF_OPEN breaker has completed its wait interval and will allow requests
      METRICS_ONLY
      A METRICS_ONLY breaker is collecting metrics, publishing events and allowing all requests through but is not transitioning to other states.
      OPEN
      An OPEN breaker has tripped and will not allow requests through.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean allowPublish  

    • Method Summary

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

      • DISABLED

        public static final CircuitBreaker.State DISABLED
        A DISABLED breaker is not operating (no state transition, no events) and allowing all requests through.

      • METRICS_ONLY

        public static final CircuitBreaker.State METRICS_ONLY
        A METRICS_ONLY breaker is collecting metrics, publishing events and allowing all requests through but is not transitioning to other states.

      • CLOSED

        public static final CircuitBreaker.State CLOSED
        A CLOSED breaker is operating normally and allowing requests through.

      • OPEN

        public static final CircuitBreaker.State OPEN
        An OPEN breaker has tripped and will not allow requests through.

      • FORCED_OPEN

        public static final CircuitBreaker.State FORCED_OPEN
        A FORCED_OPEN breaker is not operating (no state transition, no events) and not allowing any requests through.

      • HALF_OPEN

        public static final CircuitBreaker.State HALF_OPEN
        A HALF_OPEN breaker has completed its wait interval and will allow requests

    • Field Detail

      • allowPublish

        public final boolean allowPublish

    • Method Detail

      • values

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

      • valueOf

        public static CircuitBreaker.State 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

      • getOrder

        public int getOrder()