Enum Class MonitoringIndex

java.lang.Object
java.lang.Enum<MonitoringIndex>
org.elasticsearch.xpack.core.monitoring.action.MonitoringIndex
All Implemented Interfaces:
Serializable, Comparable<MonitoringIndex>, Constable, Writeable

public enum MonitoringIndex extends Enum<MonitoringIndex> implements 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.

  • Enum Constant Details

    • IGNORED_DATA

      public static final MonitoringIndex IGNORED_DATA
      A formerly used index format, which is no longer relevant. This is maintained to allow BWC for older clients.
    • TIMESTAMPED

      public static final MonitoringIndex TIMESTAMPED
      Timestamped data that drives the charts (e.g., memory statistics).
  • Method Details

    • values

      public static MonitoringIndex[] 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 MonitoringIndex 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
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • readFrom

      public static MonitoringIndex readFrom(StreamInput in) throws IOException
      Throws:
      IOException
    • matchesIndexName

      public abstract boolean matchesIndexName(String indexName)
      Determine if the indexName matches this monitoring index.
      Parameters:
      indexName - The name of the index.
      Returns:
      true if this matches the indexName
    • from

      public static MonitoringIndex from(String indexName)
      Find the MonitoringIndex to use for the request.
      Parameters:
      indexName - The name of the index.
      Returns:
      Never null.
      Throws:
      IllegalArgumentException - if indexName is unrecognized