com.ace.moab.api.triggers
Enum TriggerThresholdMetric

java.lang.Object
  java.lang.Enum<TriggerThresholdMetric>
      com.ace.moab.api.triggers.TriggerThresholdMetric

All Implemented Interfaces:

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

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

This enum describes the metric to use when measuring the threshold used to fire a trigger. This metric is only used if a threshold is specified for a given trigger.

See Also:

TriggerThreshold

Enum Constant Summary

AVAILABILITY

BACKLOG

GMETRIC

QUEUETIME

USAGE
Only enabled for reservation triggers and is specified as a percentage of utilization.

XFACTOR

Method Summary

static TriggerThresholdMetric	parseString(java.lang.String string) Parses a string and converts it into a TriggerThresholdMetric object.
static TriggerThresholdMetric	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TriggerThresholdMetric[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AVAILABILITY

public static final TriggerThresholdMetric AVAILABILITY

BACKLOG

public static final TriggerThresholdMetric BACKLOG

GMETRIC

public static final TriggerThresholdMetric GMETRIC

QUEUETIME

public static final TriggerThresholdMetric QUEUETIME

USAGE

public static final TriggerThresholdMetric USAGE

Only enabled for reservation triggers and is specified as a percentage of utilization.

XFACTOR

public static final TriggerThresholdMetric XFACTOR

Method Detail

values

public static final TriggerThresholdMetric[] values()

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

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

Returns:

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

valueOf

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

parseString

public static TriggerThresholdMetric parseString(java.lang.String string)

Parses a string and converts it into a TriggerThresholdMetric object. If the String is unrecognizable, null is returned.

Parameters:

string - the string to be parsed.

Returns:

the corresponding TriggerFlags object.