blob: 6c8eff32e787b19fe059570c715118d322ded70b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:09:35 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.yarn.api.records.timelineservice (Apache Hadoop YARN API 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.hadoop.yarn.api.records.timelineservice (Apache Hadoop YARN API 3.3.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timeline/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/api/resource/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/api/records/timelineservice/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p>@InterfaceAudience.Public
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.yarn.api.records.timelineservice</h1>
<div class="docSummary">
<div class="block">Package org.apache.hadoop.yarn.api.records.timelineservice contains classes
which define the data model for ATSv2.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/ApplicationAttemptEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">ApplicationAttemptEntity</a></td>
<td class="colLast">
<div class="block">This entity represents an application attempt.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/ApplicationEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">ApplicationEntity</a></td>
<td class="colLast">
<div class="block">This entity represents an application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/ClusterEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">ClusterEntity</a></td>
<td class="colLast">
<div class="block">This entity represents a YARN cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/ContainerEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">ContainerEntity</a></td>
<td class="colLast">
<div class="block">This entity represents a container belonging to an application attempt.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/FlowActivityEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">FlowActivityEntity</a></td>
<td class="colLast">
<div class="block">Entity that represents a record for flow activity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/FlowRunEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">FlowRunEntity</a></td>
<td class="colLast">
<div class="block">This entity represents a flow run.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/HierarchicalTimelineEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">HierarchicalTimelineEntity</a></td>
<td class="colLast">
<div class="block">This class extends timeline entity and defines parent-child relationships
with other entities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/QueueEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">QueueEntity</a></td>
<td class="colLast">
<div class="block">This entity represents a queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/SubApplicationEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">SubApplicationEntity</a></td>
<td class="colLast">
<div class="block">This entity represents a user defined entities to be stored under sub
application table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineDomain.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineDomain</a></td>
<td class="colLast">
<div class="block">
This class contains the information about a timeline service domain, which is
used to a user to host a number of timeline entities, isolating them from
others'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineEntities.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineEntities</a></td>
<td class="colLast">
<div class="block">This class hosts a set of timeline entities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineEntity</a></td>
<td class="colLast">
<div class="block">The basic timeline entity data structure for timeline service v2.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineEntity.Identifier.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineEntity.Identifier</a></td>
<td class="colLast">
<div class="block">Identifier of timeline entity(entity id + entity type).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineEvent.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineEvent</a></td>
<td class="colLast">
<div class="block">This class contains the information of an event that belongs to an entity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineMetric.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineMetric</a></td>
<td class="colLast">
<div class="block">This class contains the information of a metric that is related to some
entity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineMetricCalculator.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineMetricCalculator</a></td>
<td class="colLast">
<div class="block">A calculator for timeline metrics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineWriteResponse.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineWriteResponse</a></td>
<td class="colLast">
<div class="block">A class that holds a list of put errors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineWriteResponse.TimelineWriteError.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">TimelineWriteResponse.TimelineWriteError</a></td>
<td class="colLast">
<div class="block">A class that holds the error code for one entity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/UserEntity.html" title="class in org.apache.hadoop.yarn.api.records.timelineservice">UserEntity</a></td>
<td class="colLast">
<div class="block">This entity represents a user.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineEntityType.html" title="enum in org.apache.hadoop.yarn.api.records.timelineservice">TimelineEntityType</a></td>
<td class="colLast">
<div class="block">Defines type of entity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineMetric.Type.html" title="enum in org.apache.hadoop.yarn.api.records.timelineservice">TimelineMetric.Type</a></td>
<td class="colLast">
<div class="block">Type of metric.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timelineservice/TimelineMetricOperation.html" title="enum in org.apache.hadoop.yarn.api.records.timelineservice">TimelineMetricOperation</a></td>
<td class="colLast">
<div class="block">Aggregation operations.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.yarn.api.records.timelineservice Description">Package org.apache.hadoop.yarn.api.records.timelineservice Description</h2>
<div class="block">Package org.apache.hadoop.yarn.api.records.timelineservice contains classes
which define the data model for ATSv2.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/hadoop/yarn/api/records/timeline/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/api/resource/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/api/records/timelineservice/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>