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

Enum TimelineEntityType

java.lang.Object

java.lang.Enum<TimelineEntityType>

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

All Implemented Interfaces:

Serializable, Comparable<TimelineEntityType>

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public enum TimelineEntityType
extends Enum<TimelineEntityType>

Defines type of entity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
YARN_APPLICATION
YARN_APPLICATION_ATTEMPT
YARN_CLUSTER
YARN_CONTAINER
YARN_FLOW_ACTIVITY
YARN_FLOW_RUN
YARN_QUEUE
YARN_USER

Method Summary

Modifier and Type	Method and Description
boolean	isChild(TimelineEntityType type) Whether the input type can be a child of this entity.
boolean	isParent(TimelineEntityType type) Whether the input type can be a parent of this entity.
boolean	matches(String typeString) Whether the type of this entity matches the type indicated by the input argument.
static TimelineEntityType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimelineEntityType[]	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

YARN_CLUSTER

public static final TimelineEntityType YARN_CLUSTER

YARN_FLOW_RUN

public static final TimelineEntityType YARN_FLOW_RUN

YARN_APPLICATION

public static final TimelineEntityType YARN_APPLICATION

YARN_APPLICATION_ATTEMPT

public static final TimelineEntityType YARN_APPLICATION_ATTEMPT

YARN_CONTAINER

public static final TimelineEntityType YARN_CONTAINER

YARN_USER

public static final TimelineEntityType YARN_USER

YARN_QUEUE

public static final TimelineEntityType YARN_QUEUE

YARN_FLOW_ACTIVITY

public static final TimelineEntityType YARN_FLOW_ACTIVITY

Method Detail

values

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

Returns:

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

valueOf

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

isParent

public boolean isParent(TimelineEntityType type)

Whether the input type can be a parent of this entity.

Parameters:

type - entity type.

Returns:

true, if this entity type is parent of passed entity type, false otherwise.

isChild

public boolean isChild(TimelineEntityType type)

Whether the input type can be a child of this entity.

Parameters:

type - entity type.

Returns:

true, if this entity type is child of passed entity type, false otherwise.

matches

public boolean matches(String typeString)

Whether the type of this entity matches the type indicated by the input argument.

Parameters:

typeString - entity type represented as a string.

Returns:

true, if string representation of this entity type matches the entity type passed.