Package org.opensearch.client.opensearch.indices

Enum Class IndexRoutingRebalanceOptions

java.lang.Object

java.lang.Enum<IndexRoutingRebalanceOptions>

org.opensearch.client.opensearch.indices.IndexRoutingRebalanceOptions

All Implemented Interfaces:

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

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

The options for shard rebalancing 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 rebalancing of all shards.
None	Prevents shard rebalancing.
Primaries	Allows rebalancing of primary shards only.
Replicas	Allows rebalancing of replica shards only.

Field Summary

Fields

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

Method Summary

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

Allows rebalancing of all shards.

None

public static final IndexRoutingRebalanceOptions None

Prevents shard rebalancing.

Primaries

public static final IndexRoutingRebalanceOptions Primaries

Allows rebalancing of primary shards only.

Replicas

public static final IndexRoutingRebalanceOptions Replicas

Allows rebalancing of replica shards only.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<IndexRoutingRebalanceOptions> _DESERIALIZER

Method Details

values

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