MsInfo (Apache Hadoop Common 3.5.0 API)
Description: declaration: package: org.apache.hadoop.metrics2.impl, enum: MsInfo

Package org.apache.hadoop.metrics2.impl

# Enum Class MsInfo

java.lang.Object
java.lang.Enum<MsInfo>
org.apache.hadoop.metrics2.impl.MsInfo

All Implemented Interfaces:
  `Serializable`, `Comparable<MsInfo>`, `Constable`, `MetricsInfo`

@Private public enum MsInfo extends Enum<MsInfo> implements MetricsInfo
Metrics system related metrics info instances

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `Context`
  `Hostname`
  `NumActiveSinks`
  `NumActiveSources`
  `NumAllSinks`
  `NumAllSources`
  `ProcessName`
  `SessionId`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `description()`
  Typically the description corresponds to annotation `Metric.about()` or the name of the class.
  `String`
  `toString()`
  `static MsInfo`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static MsInfo[]`
  `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, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

  ### Methods inherited from interface org.apache.hadoop.metrics2.MetricsInfo

  `name`

- ## Enum Constant Details

  - ### NumActiveSources

    public static final MsInfo NumActiveSources

  - ### NumAllSources

    public static final MsInfo NumAllSources

  - ### NumActiveSinks

    public static final MsInfo NumActiveSinks

  - ### NumAllSinks

    public static final MsInfo NumAllSinks

  - ### Context

    public static final MsInfo Context

  - ### Hostname

    public static final MsInfo Hostname

  - ### SessionId

    public static final MsInfo SessionId

  - ### ProcessName

    public static final MsInfo ProcessName

- ## Method Details

  - ### values

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

  - ### description

    public String description()
    Description copied from interface: `MetricsInfo`
    Typically the description corresponds to annotation `Metric.about()` or the name of the class.
    Specified by:
      `description` in interface `MetricsInfo`
    Returns:
      the description of the metric/tag

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Enum<MsInfo>`