software.amazon.kinesis.metrics

Enum MetricsLevel

java.lang.Object

java.lang.Enum<MetricsLevel>

software.amazon.kinesis.metrics.MetricsLevel

All Implemented Interfaces:

Serializable, Comparable<MetricsLevel>

public enum MetricsLevel
extends Enum<MetricsLevel>

This class defines a set of standard metrics levels that can be used to control which metrics get emitted. MetricsLevel objects are ordered and are specified by ordered integers. Enabling metrics at a given level also enables the metrics at all higher levels.

Metrics levels in descending order are:

• SUMMARY
• DETAILED

In addition, NONE level can be used to turn off all metrics.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DETAILED DETAILED metrics level can be used to emit all metrics.
NONE NONE metrics level can be used to turn off metrics.
SUMMARY SUMMARY metrics level can be used to emit only the most significant metrics.

Method Summary

Modifier and Type	Method and Description
static MetricsLevel	fromName(String name) Returns metrics level associated with the given name.
String	getName() Returns the name for this metrics level.
int	getValue() Returns the value for this metrics level.
static MetricsLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricsLevel[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final MetricsLevel NONE

NONE metrics level can be used to turn off metrics.

SUMMARY

public static final MetricsLevel SUMMARY

SUMMARY metrics level can be used to emit only the most significant metrics.

DETAILED

public static final MetricsLevel DETAILED

DETAILED metrics level can be used to emit all metrics.

Method Detail

values

public static MetricsLevel[] 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 (MetricsLevel c : MetricsLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static MetricsLevel valueOf(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:

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

NullPointerException - if the argument is null

getName

public String getName()

Returns the name for this metrics level.

Returns:

Returns the name for this metrics level.

getValue

public int getValue()

Returns the value for this metrics level.

Returns:

Returns the value for this metrics level.

fromName

public static MetricsLevel fromName(String name)

Returns metrics level associated with the given name.

Parameters:

name - Name of the metrics level.

Returns:

Returns metrics level associated with the given name.