Package org.kiwiproject.consul.model

Enum Class State

java.lang.Object

java.lang.Enum<State>

org.kiwiproject.consul.model.State

All Implemented Interfaces:

Serializable, Comparable<State>, Constable

public enum State
extends Enum<State>

Represents the possible Check states.

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
ANY
FAIL
PASS
UNKNOWN
WARN

Method Summary

Modifier and Type	Method	Description
static State	fromName(String name)	Returns the appropriate State given the name.
String	getName()	Retrieve the name value for the Consul check API endpoints.
String	getPath()	Retrieve the path value for the Consul check API endpoints.
static State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static State[]	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

PASS

public static final State PASS

WARN

public static final State WARN

FAIL

public static final State FAIL

ANY

public static final State ANY

UNKNOWN

public static final State UNKNOWN

Method Details

values

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

getPath

public String getPath()

Retrieve the path value for the Consul check API endpoints.

Returns:

The path value, e.g. "pass" for PASS.

getName

public String getName()

Retrieve the name value for the Consul check API endpoints. This is the value to use for querying services by health state.

Returns:

The name, e.g. "passing" for PASS.

fromName

public static State fromName(String name)

Returns the appropriate State given the name.

Parameters:

name - The state name e.g. "passing".

Returns:

The state.