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

Class TimelineEvent

java.lang.Object

org.apache.hadoop.yarn.api.records.timeline.TimelineEvent

All Implemented Interfaces:

java.lang.Comparable<TimelineEvent>

@Public
@Evolving
public class TimelineEvent
extends java.lang.Object
implements java.lang.Comparable<TimelineEvent>

The class that contains the information of an event that is related to some conceptual entity of an application. Users are free to define what the event means, such as starting an application, getting allocated a container and etc.

Constructor Summary

Constructors

Constructor	Description
TimelineEvent()

Method Summary

Modifier and Type	Method	Description
void	addEventInfo(java.lang.String key, java.lang.Object value)	Add one piece of the information of the event to the existing information map
void	addEventInfo(java.util.Map<java.lang.String,java.lang.Object> eventInfo)	Add a map of the information of the event to the existing information map
int	compareTo(TimelineEvent other)
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.Object>	getEventInfo()	Set the information of the event
java.util.HashMap<java.lang.String,java.lang.Object>	getEventInfoJAXB()
java.lang.String	getEventType()	Get the event type
long	getTimestamp()	Get the timestamp of the event
int	hashCode()
void	setEventInfo(java.util.Map<java.lang.String,java.lang.Object> eventInfo)	Set the information map to the given map of the information of the event
void	setEventType(java.lang.String eventType)	Set the event type
void	setTimestamp(long timestamp)	Set the timestamp of the event

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimelineEvent

public TimelineEvent()

Method Detail

getTimestamp

public long getTimestamp()

Get the timestamp of the event

Returns:

the timestamp of the event

setTimestamp

public void setTimestamp(long timestamp)

Set the timestamp of the event

Parameters:

timestamp - the timestamp of the event

getEventType

public java.lang.String getEventType()

Get the event type

Returns:

the event type

setEventType

public void setEventType(java.lang.String eventType)

Set the event type

Parameters:

eventType - the event type

getEventInfo

public java.util.Map<java.lang.String,java.lang.Object> getEventInfo()

Set the information of the event

Returns:

the information of the event

getEventInfoJAXB

@Private
public java.util.HashMap<java.lang.String,java.lang.Object> getEventInfoJAXB()

addEventInfo

public void addEventInfo(java.lang.String key,
                         java.lang.Object value)

Add one piece of the information of the event to the existing information map

Parameters:

key - the information key

value - the information value

addEventInfo

public void addEventInfo(java.util.Map<java.lang.String,java.lang.Object> eventInfo)

Add a map of the information of the event to the existing information map

Parameters:

eventInfo - a map of of the information of the event

setEventInfo

public void setEventInfo(java.util.Map<java.lang.String,java.lang.Object> eventInfo)

Set the information map to the given map of the information of the event

Parameters:

eventInfo - a map of of the information of the event

compareTo

public int compareTo(TimelineEvent other)

Specified by:

compareTo in interface java.lang.Comparable<TimelineEvent>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object