Package org.opensearch.client.opensearch.indices.shard_stores

Enum Class ShardStoreStatus

java.lang.Object

java.lang.Enum<ShardStoreStatus>

org.opensearch.client.opensearch.indices.shard_stores.ShardStoreStatus

All Implemented Interfaces:

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

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

The status of shard stores.

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
All	Return all shards, regardless of health status.
Green	The primary shard and all replica shards are assigned.
Red	The primary shard is unassigned.
Yellow	One or more replica shards are unassigned.

Field Summary

Fields

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

Method Summary

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

aliases, serialize

Enum Constant Details

All

public static final ShardStoreStatus All

Return all shards, regardless of health status.

Green

public static final ShardStoreStatus Green

The primary shard and all replica shards are assigned.

Red

public static final ShardStoreStatus Red

The primary shard is unassigned.

Yellow

public static final ShardStoreStatus Yellow

One or more replica shards are unassigned.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<ShardStoreStatus> _DESERIALIZER

Method Details

values

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