Package org.elasticsearch.cluster.health

Enum ClusterHealthStatus

java.lang.Object

java.lang.Enum<ClusterHealthStatus>

org.elasticsearch.cluster.health.ClusterHealthStatus

All Implemented Interfaces:

Serializable, Comparable<ClusterHealthStatus>, Writeable

public enum ClusterHealthStatus
extends Enum<ClusterHealthStatus>
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GREEN
RED
YELLOW

Method Summary

Modifier and Type	Method	Description
static ClusterHealthStatus	fromString(String status)
static ClusterHealthStatus	fromValue(byte value)
static ClusterHealthStatus	readFrom(StreamInput in)	Read from a stream.
byte	value()
static ClusterHealthStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClusterHealthStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

GREEN

public static final ClusterHealthStatus GREEN

YELLOW

public static final ClusterHealthStatus YELLOW

RED

public static final ClusterHealthStatus RED

Method Detail

values

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

Returns:

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

valueOf

public static ClusterHealthStatus 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

value

public byte value()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

readFrom

public static ClusterHealthStatus readFrom(StreamInput in)
                                    throws IOException

Read from a stream.

Throws:

IllegalArgumentException - if the value is unrecognized

IOException

fromValue

public static ClusterHealthStatus fromValue(byte value)
                                     throws IOException

Throws:

IOException

fromString

public static ClusterHealthStatus fromString(String status)