blob: dfd77540d1c163ffa59fb4f3a8cdf3d42ca2525f [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.resource (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.resource (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/timelineservice/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/hadoop/yarn/conf/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/api/resource/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">
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.yarn.api.resource</h1>
<div class="docSummary">
<div class="block">API related to resources.</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="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.Visitable.html" title="interface in org.apache.hadoop.yarn.api.resource">PlacementConstraint.Visitable</a></td>
<td class="colLast">
<div class="block">Interface used to enable the elements of the constraint tree to be visited.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.Visitor.html" title="interface in org.apache.hadoop.yarn.api.resource">PlacementConstraint.Visitor</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Visitor API for a constraint tree.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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/resource/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint</a></td>
<td class="colLast">
<div class="block"><code>PlacementConstraint</code> represents a placement constraint for a resource
allocation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.AbstractConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.AbstractConstraint</a></td>
<td class="colLast">
<div class="block">Abstract class that acts as the superclass of all placement constraint
classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.And.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.And</a></td>
<td class="colLast">
<div class="block">Class that represents a composite constraint that is a conjunction of other
constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.CardinalityConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.CardinalityConstraint</a></td>
<td class="colLast">
<div class="block">Class that represents a cardinality constraint.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.CompositeConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.CompositeConstraint</a>&lt;R extends <a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.Visitable.html" title="interface in org.apache.hadoop.yarn.api.resource">PlacementConstraint.Visitable</a>&gt;</td>
<td class="colLast">
<div class="block">Class that represents composite constraints, which comprise other
constraints, forming a constraint tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.DelayedOr.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.DelayedOr</a></td>
<td class="colLast">
<div class="block">Class that represents a composite constraint that comprises a list of timed
placement constraints (see <a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.TimedPlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource"><code>PlacementConstraint.TimedPlacementConstraint</code></a>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.Or.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.Or</a></td>
<td class="colLast">
<div class="block">Class that represents a composite constraint that is a disjunction of other
constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.SingleConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.SingleConstraint</a></td>
<td class="colLast">
<div class="block">Consider a set of nodes N that belongs to the scope specified in the
constraint.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.TargetConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.TargetConstraint</a></td>
<td class="colLast">
<div class="block">Class that represents a target constraint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.TargetExpression.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.TargetExpression</a></td>
<td class="colLast">
<div class="block">Class representing the target expressions that are used in placement
constraints.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.TimedPlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint.TimedPlacementConstraint</a></td>
<td class="colLast">
<div class="block">Represents a timed placement constraint that has to be satisfied within a
time window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraints.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraints</a></td>
<td class="colLast">
<div class="block">This class contains various static methods for the applications to create
placement constraints (see also <a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource"><code>PlacementConstraint</code></a>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraints.PlacementTargets.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraints.PlacementTargets</a></td>
<td class="colLast">
<div class="block">Class with static methods for constructing target expressions to be used in
placement constraints.</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/resource/PlacementConstraint.TargetExpression.TargetType.html" title="enum in org.apache.hadoop.yarn.api.resource">PlacementConstraint.TargetExpression.TargetType</a></td>
<td class="colLast">
<div class="block">Enum specifying the type of the target expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.TimedPlacementConstraint.DelayUnit.html" title="enum in org.apache.hadoop.yarn.api.resource">PlacementConstraint.TimedPlacementConstraint.DelayUnit</a></td>
<td class="colLast">
<div class="block">The unit of scheduling delay.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.yarn.api.resource Description">Package org.apache.hadoop.yarn.api.resource Description</h2>
<div class="block">API related to resources.</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/timelineservice/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/hadoop/yarn/conf/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/api/resource/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>