Module org.elasticsearch.xcore
Enum Class MonitoringIndex
- All Implemented Interfaces:
Serializable,Comparable<MonitoringIndex>,Constable,Writeable
MonitoringIndex represents the receivable index from any request.
This allows external systems to provide details for an index without having to know its exact name.
-
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.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA formerly used index format, which is no longer relevant.Timestamped data that drives the charts (e.g., memory statistics). -
Method Summary
Modifier and TypeMethodDescriptionstatic MonitoringIndexFind theMonitoringIndexto use for the request.abstract booleanmatchesIndexName(String indexName) Determine if theindexNamematchesthismonitoring index.static MonitoringIndexreadFrom(StreamInput in) static MonitoringIndexReturns the enum constant of this class with the specified name.static MonitoringIndex[]values()Returns an array containing the constants of this enum class, in the order they are declared.voidwriteTo(StreamOutput out)
-
Enum Constant Details
-
IGNORED_DATA
A formerly used index format, which is no longer relevant. This is maintained to allow BWC for older clients. -
TIMESTAMPED
Timestamped data that drives the charts (e.g., memory statistics).
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
readFrom
- Throws:
IOException
-
matchesIndexName
Determine if theindexNamematchesthismonitoring index.- Parameters:
indexName- The name of the index.- Returns:
trueifthismatches theindexName
-
from
Find theMonitoringIndexto use for the request.- Parameters:
indexName- The name of the index.- Returns:
- Never
null. - Throws:
IllegalArgumentException- ifindexNameis unrecognized
-