blob: 2bc3098f838e6b3f3f216780c0b07b1cdc33df2c [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:12:13 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint (Apache Hadoop YARN ResourceManager 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.server.resourcemanager.scheduler.constraint (Apache Hadoop YARN ResourceManager 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/server/resourcemanager/scheduler/common/fica/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/algorithm/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/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.Private
@InterfaceStability.Unstable
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint</h1>
<div class="docSummary">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement
contains classes related to scheduling containers using placement
constraints.</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/server/resourcemanager/scheduler/constraint/Evaluable.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">Evaluable</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A class implements Evaluable interface represents the internal state
of the class can be changed against a given target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManager</a></td>
<td class="colLast">
<div class="block">Interface for storing and retrieving placement constraints (see
<code>PlacementConstraint</code>).</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/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTags</a></td>
<td class="colLast">
<div class="block">Allocation tags under same namespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager</a></td>
<td class="colLast">
<div class="block">In-memory mapping between applications/container-tags and nodes/racks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager.TypeToCountedTags</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Generic store mapping type T to counted tags.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/MemoryPlacementConstraintManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">MemoryPlacementConstraintManager</a></td>
<td class="colLast">
<div class="block">In memory implementation of the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManagerService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><code>PlacementConstraintManagerService</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManagerService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManagerService</a></td>
<td class="colLast">
<div class="block">The service that implements the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><code>PlacementConstraintManager</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintsUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintsUtil</a></td>
<td class="colLast">
<div class="block">This class contains various static methods used by the Placement Algorithms
to simplify constrained placement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplications.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplications</a></td>
<td class="colLast">
<div class="block">This class is used by
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.html#evaluate-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.TargetApplications-"><code>TargetApplicationsNamespace.evaluate(TargetApplications)</code></a> to evaluate
a namespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplicationsNamespace</a></td>
<td class="colLast">
<div class="block">Class to describe the namespace of allocation tags, used by
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><code>AllocationTags</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.All.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplicationsNamespace.All</a></td>
<td class="colLast">
<div class="block">Namespace to all applications in the cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.AppID.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplicationsNamespace.AppID</a></td>
<td class="colLast">
<div class="block">Namespace defined by a certain application ID.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.AppTag.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplicationsNamespace.AppTag</a></td>
<td class="colLast">
<div class="block">Namespace to applications that attached with a certain application tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.NotSelf.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplicationsNamespace.NotSelf</a></td>
<td class="colLast">
<div class="block">Namespace to all applications except itself.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/TargetApplicationsNamespace.Self.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">TargetApplicationsNamespace.Self</a></td>
<td class="colLast">
<div class="block">Namespace within application itself.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></td>
<td class="colLast">
<div class="block">Exception when invalid parameter specified to do placement tags related
queries.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint Description">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint Description</h2>
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement
contains classes related to scheduling containers using placement
constraints.</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/server/resourcemanager/scheduler/common/fica/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/algorithm/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/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>