org.apache.giraph.metrics

Enum MeterDesc

java.lang.Object

java.lang.Enum<MeterDesc>

org.apache.giraph.metrics.MeterDesc

All Implemented Interfaces:

Serializable, Comparable<MeterDesc>

public enum MeterDesc
extends Enum<MeterDesc>

Description for Meters used in Giraph.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDGES_LOADED Total edges loaded
RECEIVED_REQUESTS Number of requests received
SENT_REQUESTS Number of requests sent
VERTICES_LOADED Total vertices loaded

Method Summary

Modifier and Type	Method and Description
String	getName() Get name of meter
TimeUnit	getTimeUnit() Get TimeUnit of meter
String	getType() Get type of meter
static MeterDesc	valueOf(String name) Returns the enum constant of this type with the specified name.
static MeterDesc[]	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

RECEIVED_REQUESTS

public static final MeterDesc RECEIVED_REQUESTS

Number of requests received

SENT_REQUESTS

public static final MeterDesc SENT_REQUESTS

Number of requests sent

EDGES_LOADED

public static final MeterDesc EDGES_LOADED

Total edges loaded

VERTICES_LOADED

public static final MeterDesc VERTICES_LOADED

Total vertices loaded

Method Detail

values

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

Returns:

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

valueOf

public static MeterDesc 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()

Get name of meter

Returns:

String name

getTimeUnit

public TimeUnit getTimeUnit()

Get TimeUnit of meter

Returns:

TimeUnit

getType

public String getType()

Get type of meter

Returns:

String type