com.oracle.bmc.circuitbreaker

Enum CircuitBreakerState

java.lang.Object

java.lang.Enum<CircuitBreakerState>

com.oracle.bmc.circuitbreaker.CircuitBreakerState

All Implemented Interfaces:

Serializable, Comparable<CircuitBreakerState>

public enum CircuitBreakerState
extends Enum<CircuitBreakerState>

Enum Constant Summary

Enum Constants

Enum Constant and 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
OPEN An OPEN breaker has tripped and will not allow requests through.
UNKNOWN The underlying implementation has an unmapped state

Method Summary

Modifier and Type	Method and Description
static CircuitBreakerState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CircuitBreakerState[]	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 CircuitBreakerState DISABLED

A DISABLED breaker is not operating (no state transition, no events) and allowing all requests through.

CLOSED

public static final CircuitBreakerState CLOSED

A CLOSED breaker is operating normally and allowing requests through.

OPEN

public static final CircuitBreakerState OPEN

An OPEN breaker has tripped and will not allow requests through.

FORCED_OPEN

public static final CircuitBreakerState 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 CircuitBreakerState HALF_OPEN

A HALF_OPEN breaker has completed its wait interval and will allow requests

UNKNOWN

public static final CircuitBreakerState UNKNOWN

The underlying implementation has an unmapped state

Method Detail

values

public static CircuitBreakerState[] 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 (CircuitBreakerState c : CircuitBreakerState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CircuitBreakerState valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null