Package org.opensearch.client.opensearch.indices

Enum Class IndexRoutingAllocationOptions

java.lang.Object

java.lang.Enum<IndexRoutingAllocationOptions>

org.opensearch.client.opensearch.indices.IndexRoutingAllocationOptions

All Implemented Interfaces:

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

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

The options for shard allocation control.

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	Allows shard allocation for all shards.
NewPrimaries	Allows shard allocation only for new primary shards.
None	Prevents shard allocation.
Primaries	Allows shard allocation only for primary shards.

Field Summary

Fields

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

Method Summary

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

Allows shard allocation for all shards.

NewPrimaries

public static final IndexRoutingAllocationOptions NewPrimaries

Allows shard allocation only for new primary shards.

None

public static final IndexRoutingAllocationOptions None

Prevents shard allocation.

Primaries

public static final IndexRoutingAllocationOptions Primaries

Allows shard allocation only for primary shards.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<IndexRoutingAllocationOptions> _DESERIALIZER

Method Details

values

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