Package org.opensearch.client.opensearch.nodes.info

Enum Class NodesInfoMetric

java.lang.Object

java.lang.Enum<NodesInfoMetric>

org.opensearch.client.opensearch.nodes.info.NodesInfoMetric

All Implemented Interfaces:

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

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

The nodes metrics to retrieve.

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
Aggregations	Returns aggregation information.
All	Returns all metrics.
Http	Returns HTTP connection information.
Indices	Returns indices stats and settings.
Ingest	Returns ingest pipeline information.
Jvm	Returns JVM stats, process information, and memory usage.
Os	Returns operating system information and stats.
Plugins	Returns installed plugins information.
Process	Returns process statistics.
SearchPipelines	Returns search pipeline configurations.
Settings	Returns node settings information.
ThreadPool	Returns thread pool information.
Transport	Returns transport layer information.

Field Summary

Fields

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

Method Summary

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

Returns all metrics.

Aggregations

public static final NodesInfoMetric Aggregations

Returns aggregation information.

Http

public static final NodesInfoMetric Http

Returns HTTP connection information.

Indices

public static final NodesInfoMetric Indices

Returns indices stats and settings.

Ingest

public static final NodesInfoMetric Ingest

Returns ingest pipeline information.

Jvm

public static final NodesInfoMetric Jvm

Returns JVM stats, process information, and memory usage.

Os

public static final NodesInfoMetric Os

Returns operating system information and stats.

Plugins

public static final NodesInfoMetric Plugins

Returns installed plugins information.

Process

public static final NodesInfoMetric Process

Returns process statistics.

SearchPipelines

public static final NodesInfoMetric SearchPipelines

Returns search pipeline configurations.

Settings

public static final NodesInfoMetric Settings

Returns node settings information.

ThreadPool

public static final NodesInfoMetric ThreadPool

Returns thread pool information.

Transport

public static final NodesInfoMetric Transport

Returns transport layer information.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<NodesInfoMetric> _DESERIALIZER

Method Details

values

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