Package org.apache.hadoop.yarn.api.records.timelineservice

Enum TimelineMetricOperation

java.lang.Object

java.lang.Enum<TimelineMetricOperation>

org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimelineMetricOperation>

public enum TimelineMetricOperation
extends java.lang.Enum<TimelineMetricOperation>

Aggregation operations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVG
MAX
NOP
REPLACE
SUM

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PREV_METRIC_STATE_KEY

Method Summary

Modifier and Type	Method	Description
TimelineMetric	aggregate(TimelineMetric incoming, TimelineMetric aggregate, java.util.Map<java.lang.Object,java.lang.Object> state)	Perform the aggregation operation.
java.lang.String	toString()
static TimelineMetricOperation	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TimelineMetricOperation[]	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

Enum Constant Detail

NOP

public static final TimelineMetricOperation NOP

MAX

public static final TimelineMetricOperation MAX

REPLACE

public static final TimelineMetricOperation REPLACE

SUM

public static final TimelineMetricOperation SUM

AVG

public static final TimelineMetricOperation AVG

Field Detail

PREV_METRIC_STATE_KEY

public static final java.lang.String PREV_METRIC_STATE_KEY

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static TimelineMetricOperation 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

aggregate

public TimelineMetric aggregate(TimelineMetric incoming,
                                TimelineMetric aggregate,
                                java.util.Map<java.lang.Object,java.lang.Object> state)

Perform the aggregation operation.

Parameters:

incoming - Incoming metric

aggregate - Base aggregation metric

state - Operation state

Returns:

Result metric for this aggregation operation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TimelineMetricOperation>