Package org.apache.hadoop.metrics2.impl

Enum MsInfo

java.lang.Object

java.lang.Enum<MsInfo>

org.apache.hadoop.metrics2.impl.MsInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MsInfo>, MetricsInfo

@Private
public enum MsInfo
extends java.lang.Enum<MsInfo>
implements MetricsInfo

Metrics system related metrics info instances

Enum Constant Summary

Enum Constants

Enum Constant	Description
Context
Hostname
NumActiveSinks
NumActiveSources
NumAllSinks
NumAllSources
ProcessName
SessionId

Method Summary

Modifier and Type	Method	Description
java.lang.String	description()	Typically the description corresponds to annotation Metric.about() or the name of the class.
java.lang.String	toString()
static MsInfo	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MsInfo[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, 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 Detail

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 Detail

values

public static MsInfo[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MsInfo c : MsInfo.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MsInfo valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

description

public java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Enum<MsInfo>