Package org.opensearch.client.opensearch._types

Enum Class HealthStatus

java.lang.Object

java.lang.Enum<HealthStatus>

org.opensearch.client.opensearch._types.HealthStatus

All Implemented Interfaces:

Serializable, Comparable<HealthStatus>, Constable, JsonEnum, JsonpSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum HealthStatus
extends Enum<HealthStatus>
implements JsonEnum

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Green	All shards are assigned.
Red	One or more primary shards are unassigned, so some data is unavailable.
Yellow	All primary shards are assigned, but one or more replica shards are unassigned.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<HealthStatus>	_DESERIALIZER

Method Summary

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

Methods inherited from interface org.opensearch.client.json.JsonEnum

serialize

Enum Constant Details

Green

public static final HealthStatus Green

All shards are assigned.

Red

public static final HealthStatus Red

One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.

Yellow

public static final HealthStatus Yellow

All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<HealthStatus> _DESERIALIZER

Method Details

values

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

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum

aliases

public String[] aliases()

Specified by:

aliases in interface JsonEnum