Package org.hibernate.search.backend.elasticsearch.index

Enum IndexStatus

java.lang.Object

java.lang.Enum<IndexStatus>

org.hibernate.search.backend.elasticsearch.index.IndexStatus

All Implemented Interfaces:

Serializable, Comparable<IndexStatus>

public enum IndexStatus
extends Enum<IndexStatus>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GREEN
RED
YELLOW

Method Summary

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

GREEN

public static final IndexStatus GREEN

YELLOW

public static final IndexStatus YELLOW

RED

public static final IndexStatus RED

Method Detail

values

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

Returns:

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

valueOf

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

of

public static IndexStatus of(String value)

externalRepresentation

public String externalRepresentation()

Returns:

The expected string representation in configuration properties, which happens to be the string representation of this status in Elasticsearch's REST API.