Package org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity

Class TimelineEntityDocument

java.lang.Object

org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity.TimelineEntityDocument

All Implemented Interfaces:

TimelineDocument<TimelineEntityDocument>

public class TimelineEntityDocument
extends Object
implements TimelineDocument<TimelineEntityDocument>

This is a generic class which contains all the meta information of some conceptual entity and its related events. The timeline entity can be an application, an attempt, a container or whatever the user-defined object.

Constructor Summary

Constructors

Constructor	Description
TimelineEntityDocument()
TimelineEntityDocument(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity timelineEntity)

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity	fetchTimelineEntity()
Map<String,String>	getConfigs()
org.apache.hadoop.yarn.server.timelineservice.TimelineContext	getContext()
long	getCreatedTime()
Map<String,Set<TimelineEventSubDoc>>	getEvents()
String	getFlowVersion()
String	getId()
Map<String,Object>	getInfo()
Map<String,Set<String>>	getIsRelatedToEntities()
Map<String,Set<TimelineMetricSubDoc>>	getMetrics()
Map<String,Set<String>>	getRelatesToEntities()
String	getSubApplicationUser()
String	getType()
void	merge(TimelineEntityDocument newTimelineDocument)	Merge the TimelineEntityDocument that is passed with the current document for upsert.
void	setConfigs(Map<String,String> configs)
void	setContext(org.apache.hadoop.yarn.server.timelineservice.TimelineContext context)
void	setCreatedTime(long createdTime)
void	setEvents(Map<String,Set<TimelineEventSubDoc>> events)
void	setFlowVersion(String flowVersion)
void	setId(String key)
void	setIdentifier(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier identifier)
void	setIdPrefix(long idPrefix)
void	setInfo(Map<String,Object> info)
void	setIsRelatedToEntities(Map<String,Set<String>> isRelatedToEntities)
void	setMetrics(Map<String,Set<TimelineMetricSubDoc>> metrics)
void	setRelatesToEntities(Map<String,Set<String>> relatesToEntities)
void	setSubApplicationUser(String subApplicationUser)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Constructor Details

TimelineEntityDocument

public TimelineEntityDocument()

TimelineEntityDocument

public TimelineEntityDocument(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity timelineEntity)

Method Details

merge

public void merge(TimelineEntityDocument newTimelineDocument)

Merge the TimelineEntityDocument that is passed with the current document for upsert.

Specified by:

merge in interface TimelineDocument<TimelineEntityDocument>

Parameters:

newTimelineDocument - that has to be merged

getId

public String getId()

Specified by:

getId in interface TimelineDocument<TimelineEntityDocument>

setId

public void setId(String key)

getType

public String getType()

Specified by:

getType in interface TimelineDocument<TimelineEntityDocument>

setType

public void setType(String type)

getInfo

public Map<String,Object> getInfo()

setInfo

public void setInfo(Map<String,Object> info)

getMetrics

public Map<String,Set<TimelineMetricSubDoc>> getMetrics()

setMetrics

public void setMetrics(Map<String,Set<TimelineMetricSubDoc>> metrics)

getEvents

public Map<String,Set<TimelineEventSubDoc>> getEvents()

setEvents

public void setEvents(Map<String,Set<TimelineEventSubDoc>> events)

getConfigs

public Map<String,String> getConfigs()

setConfigs

public void setConfigs(Map<String,String> configs)

getIsRelatedToEntities

public Map<String,Set<String>> getIsRelatedToEntities()

setIsRelatedToEntities

public void setIsRelatedToEntities(Map<String,Set<String>> isRelatedToEntities)

getRelatesToEntities

public Map<String,Set<String>> getRelatesToEntities()

setRelatesToEntities

public void setRelatesToEntities(Map<String,Set<String>> relatesToEntities)

getFlowVersion

public String getFlowVersion()

setFlowVersion

public void setFlowVersion(String flowVersion)

setIdentifier

public void setIdentifier(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier identifier)

setIdPrefix

public void setIdPrefix(long idPrefix)

getSubApplicationUser

public String getSubApplicationUser()

setSubApplicationUser

public void setSubApplicationUser(String subApplicationUser)

getCreatedTime

public long getCreatedTime()

Specified by:

getCreatedTime in interface TimelineDocument<TimelineEntityDocument>

setCreatedTime

public void setCreatedTime(long createdTime)

Specified by:

setCreatedTime in interface TimelineDocument<TimelineEntityDocument>

getContext

public org.apache.hadoop.yarn.server.timelineservice.TimelineContext getContext()

setContext

public void setContext(org.apache.hadoop.yarn.server.timelineservice.TimelineContext context)

fetchTimelineEntity

public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity fetchTimelineEntity()