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

Class TimelineEntity

java.lang.Object

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

All Implemented Interfaces:

java.lang.Comparable<TimelineEntity>

Direct Known Subclasses:

FlowActivityEntity, HierarchicalTimelineEntity, UserEntity

@Public
@Unstable
public class TimelineEntity
extends java.lang.Object
implements java.lang.Comparable<TimelineEntity>

The basic timeline entity data structure for timeline service v2. Timeline entity objects are not thread safe and should not be accessed concurrently. All collection members will be initialized into empty collections. Two timeline entities are equal iff. their type and id are identical. All non-primitive type, non-collection members will be initialized into null. User should set the type and id of a timeline entity to make it valid (can be checked by using the isValid() method). Callers to the getters should perform null checks for non-primitive type, non-collection members. Callers are recommended not to alter the returned collection objects from the getters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimelineEntity.Identifier	Identifier of timeline entity(entity id + entity type).

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_ENTITY_PREFIX
protected static java.lang.String	SYSTEM_INFO_KEY_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
	TimelineEntity()
protected	TimelineEntity(java.lang.String type)
	TimelineEntity(TimelineEntity entity)	The constuctor is used to construct a proxy TimelineEntity or its subclass object from the real entity object that carries information.

Method Summary

Modifier and Type	Method	Description
void	addConfig(java.lang.String key, java.lang.String value)
void	addConfigs(java.util.Map<java.lang.String,java.lang.String> entityConfigs)
void	addEvent(TimelineEvent event)
void	addEvents(java.util.Set<TimelineEvent> entityEvents)
void	addInfo(java.lang.String key, java.lang.Object value)
void	addInfo(java.util.Map<java.lang.String,java.lang.Object> entityInfos)
void	addIsRelatedToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> isRelatedTo)
void	addIsRelatedToEntity(java.lang.String type, java.lang.String id)
void	addMetric(TimelineMetric metric)
void	addMetrics(java.util.Set<TimelineMetric> entityMetrics)
void	addRelatesToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> relatesTo)
void	addRelatesToEntity(java.lang.String type, java.lang.String id)
int	compareTo(TimelineEntity other)
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getConfigs()
java.util.HashMap<java.lang.String,java.lang.String>	getConfigsJAXB()
java.lang.Long	getCreatedTime()
java.util.NavigableSet<TimelineEvent>	getEvents()
java.lang.String	getId()
TimelineEntity.Identifier	getIdentifier()
long	getIdPrefix()
java.util.Map<java.lang.String,java.lang.Object>	getInfo()
java.util.HashMap<java.lang.String,java.lang.Object>	getInfoJAXB()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getIsRelatedToEntities()
java.util.HashMap<java.lang.String,java.util.Set<java.lang.String>>	getIsRelatedToEntitiesJAXB()
java.util.Set<TimelineMetric>	getMetrics()
protected TimelineEntity	getReal()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getRelatesToEntities()
java.util.HashMap<java.lang.String,java.util.Set<java.lang.String>>	getRelatesToEntitiesJAXB()
java.lang.String	getType()
int	hashCode()
boolean	isValid()
void	setConfigs(java.util.Map<java.lang.String,java.lang.String> entityConfigs)
void	setCreatedTime(java.lang.Long createdTs)
void	setEvents(java.util.NavigableSet<TimelineEvent> entityEvents)
void	setId(java.lang.String id)
void	setIdentifier(TimelineEntity.Identifier entityIdentifier)
void	setIdPrefix(long entityIdPrefix)	Sets idPrefix for an entity.
void	setInfo(java.util.Map<java.lang.String,java.lang.Object> entityInfos)
void	setIsRelatedToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> isRelatedTo)
void	setMetrics(java.util.Set<TimelineMetric> entityMetrics)
void	setRelatesToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> relatesTo)
void	setType(java.lang.String type)
void	setUID(java.lang.String uidKey, java.lang.String uId)	Set UID in info which will be then used for query by UI.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_INFO_KEY_PREFIX

protected static final java.lang.String SYSTEM_INFO_KEY_PREFIX

See Also:

Constant Field Values

DEFAULT_ENTITY_PREFIX

public static final long DEFAULT_ENTITY_PREFIX

See Also:

Constant Field Values

Constructor Detail

TimelineEntity

public TimelineEntity()

TimelineEntity

public TimelineEntity(TimelineEntity entity)

The constuctor is used to construct a proxy TimelineEntity or its subclass object from the real entity object that carries information.

It is usually used in the case where we want to recover class polymorphism after deserializing the entity from its JSON form.

Parameters:

entity - the real entity that carries information

TimelineEntity

protected TimelineEntity(java.lang.String type)

Method Detail

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getIdentifier

public TimelineEntity.Identifier getIdentifier()

setIdentifier

public void setIdentifier(TimelineEntity.Identifier entityIdentifier)

getInfoJAXB

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

getInfo

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

setInfo

public void setInfo(java.util.Map<java.lang.String,java.lang.Object> entityInfos)

addInfo

public void addInfo(java.util.Map<java.lang.String,java.lang.Object> entityInfos)

addInfo

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

getConfigsJAXB

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

getConfigs

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

setConfigs

public void setConfigs(java.util.Map<java.lang.String,java.lang.String> entityConfigs)

addConfigs

public void addConfigs(java.util.Map<java.lang.String,java.lang.String> entityConfigs)

addConfig

public void addConfig(java.lang.String key,
                      java.lang.String value)

getMetrics

public java.util.Set<TimelineMetric> getMetrics()

setMetrics

public void setMetrics(java.util.Set<TimelineMetric> entityMetrics)

addMetrics

public void addMetrics(java.util.Set<TimelineMetric> entityMetrics)

addMetric

public void addMetric(TimelineMetric metric)

getEvents

public java.util.NavigableSet<TimelineEvent> getEvents()

setEvents

public void setEvents(java.util.NavigableSet<TimelineEvent> entityEvents)

addEvents

public void addEvents(java.util.Set<TimelineEvent> entityEvents)

addEvent

public void addEvent(TimelineEvent event)

getIsRelatedToEntities

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getIsRelatedToEntities()

getIsRelatedToEntitiesJAXB

@Private
public java.util.HashMap<java.lang.String,java.util.Set<java.lang.String>> getIsRelatedToEntitiesJAXB()

setIsRelatedToEntities

public void setIsRelatedToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> isRelatedTo)

addIsRelatedToEntities

public void addIsRelatedToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> isRelatedTo)

addIsRelatedToEntity

public void addIsRelatedToEntity(java.lang.String type,
                                 java.lang.String id)

getRelatesToEntitiesJAXB

@Private
public java.util.HashMap<java.lang.String,java.util.Set<java.lang.String>> getRelatesToEntitiesJAXB()

getRelatesToEntities

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getRelatesToEntities()

addRelatesToEntities

public void addRelatesToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> relatesTo)

addRelatesToEntity

public void addRelatesToEntity(java.lang.String type,
                               java.lang.String id)

setRelatesToEntities

public void setRelatesToEntities(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> relatesTo)

getCreatedTime

public java.lang.Long getCreatedTime()

setCreatedTime

public void setCreatedTime(java.lang.Long createdTs)

setUID

public void setUID(java.lang.String uidKey,
                   java.lang.String uId)

Set UID in info which will be then used for query by UI.

Parameters:

uidKey - key for UID in info.

uId - UID to be set for the key.

isValid

public boolean isValid()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(TimelineEntity other)

Specified by:

compareTo in interface java.lang.Comparable<TimelineEntity>

getReal

protected TimelineEntity getReal()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIdPrefix

public long getIdPrefix()

setIdPrefix

public void setIdPrefix(long entityIdPrefix)

Sets idPrefix for an entity.

Note: Entities will be stored in the order of idPrefix specified. If users decide to set idPrefix for an entity, they MUST provide the same prefix for every update of this entity.

Example:

 TimelineEntity entity = new TimelineEntity();
 entity.setIdPrefix(value);
 

Users can use TimelineServiceHelper.invertLong(long) to invert the prefix if necessary.

Parameters:

entityIdPrefix - prefix for an entity.