Package org.opensearch.client.opensearch.cluster.reroute

Enum Class ClusterRerouteMetric

java.lang.Object

java.lang.Enum<ClusterRerouteMetric>

org.opensearch.client.opensearch.cluster.reroute.ClusterRerouteMetric

All Implemented Interfaces:

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

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum ClusterRerouteMetric
extends Enum<ClusterRerouteMetric>
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
All	Returns all available metrics.
Blocks	Returns information about cluster-level blocks.
ClusterManagerNode	Returns information about the current cluster manager node.
MasterNode	The alias for cluster_manager_node.
Metadata	Returns the cluster state metadata.
Nodes	Returns information about nodes in the cluster.
RoutingNodes	Returns the node-level shard allocations.
RoutingTable	Returns index-level shard allocations.
Version	Returns the cluster state version.

Field Summary

Fields

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

Method Summary

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

Returns all available metrics.

Blocks

public static final ClusterRerouteMetric Blocks

Returns information about cluster-level blocks.

ClusterManagerNode

public static final ClusterRerouteMetric ClusterManagerNode

Returns information about the current cluster manager node.

MasterNode

public static final ClusterRerouteMetric MasterNode

The alias for cluster_manager_node. Deprecated, but maintained for backwards compatibility.

Metadata

public static final ClusterRerouteMetric Metadata

Returns the cluster state metadata.

Nodes

public static final ClusterRerouteMetric Nodes

Returns information about nodes in the cluster.

RoutingNodes

public static final ClusterRerouteMetric RoutingNodes

Returns the node-level shard allocations.

RoutingTable

public static final ClusterRerouteMetric RoutingTable

Returns index-level shard allocations.

Version

public static final ClusterRerouteMetric Version

Returns the cluster state version.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<ClusterRerouteMetric> _DESERIALIZER

Method Details

values

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