Enum Class CircuitBreaker.Type

java.lang.Object

java.lang.Enum<CircuitBreaker.Type>

org.opensearch.core.common.breaker.CircuitBreaker.Type

All Implemented Interfaces:

Serializable, Comparable<CircuitBreaker.Type>, Constable

Enclosing interface:

CircuitBreaker

@PublicApi(since="1.0.0")
public static enum CircuitBreaker.Type
extends Enum<CircuitBreaker.Type>

The type of breaker can be MEMORY, PARENT, or NOOP

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MEMORY	A regular or ChildMemoryCircuitBreaker
NOOP	A breaker where every action is a noop, it never breaks
PARENT	A special parent-type for the hierarchy breaker service

Method Summary

Modifier and Type	Method	Description
static CircuitBreaker.Type	parseValue(String value)	Converts string (case-insensitive) to breaker CircuitBreaker.Type
static CircuitBreaker.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CircuitBreaker.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MEMORY

public static final CircuitBreaker.Type MEMORY

A regular or ChildMemoryCircuitBreaker

PARENT

public static final CircuitBreaker.Type PARENT

A special parent-type for the hierarchy breaker service

NOOP

public static final CircuitBreaker.Type NOOP

A breaker where every action is a noop, it never breaks

Method Details

values

public static CircuitBreaker.Type[] 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 CircuitBreaker.Type 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

parseValue

public static CircuitBreaker.Type parseValue(String value)

Converts string (case-insensitive) to breaker CircuitBreaker.Type

Parameters:

value - "noop", "parent", or "memory" (case-insensitive)

Returns:

the breaker CircuitBreaker.Type

Throws:

IllegalArgumentException - if value is not "noop", "parent", or "memory"