Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-mapreduce-client / hadoop-mapreduce-client-app / apidocs / org / apache / hadoop / mapreduce / v2 / app / rm / preemption / CheckpointAMPreemptionPolicy.html
blob: c07dfbb401e290d008c45617630eb59efceb1a05 [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:14:11 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CheckpointAMPreemptionPolicy (Apache Hadoop MapReduce App 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="CheckpointAMPreemptionPolicy (Apache Hadoop MapReduce App 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CheckpointAMPreemptionPolicy.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/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.Context.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/KillAMPreemptionPolicy.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html" target="_top">Frames</a></li>
<li><a href="CheckpointAMPreemptionPolicy.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.mapreduce.v2.app.rm.preemption</div>
<h2 title="Class CheckpointAMPreemptionPolicy" class="title">Class CheckpointAMPreemptionPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.mapreduce.v2.app.rm.preemption.CheckpointAMPreemptionPolicy</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CheckpointAMPreemptionPolicy</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></pre>
<div class="block">This policy works in combination with an implementation of task
checkpointing. It computes the tasks to be preempted in response to the RM
request for preemption. For strict requests, it maps containers to
corresponding tasks; for fungible requests, it attempts to pick the best
containers to preempt (reducers in reverse allocation order). The
TaskAttemptListener will interrogate this policy when handling a task
heartbeat to check whether the task should be preempted or not. When handling
fungible requests, the policy discount the RM ask by the amount of currently
in-flight preemptions (i.e., tasks that are checkpointing).
This class it is also used to maintain the list of checkpoints for existing
tasks. Centralizing this functionality here, allows us to have visibility on
preemption and checkpoints in a single location, thus coordinating preemption
and checkpoint management decisions in a single policy.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.mapreduce.v2.app.rm.preemption.AMPreemptionPolicy">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.hadoop.mapreduce.v2.app.rm.preemption.<a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></h3>
<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.Context.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy.Context</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#CheckpointAMPreemptionPolicy--">CheckpointAMPreemptionPolicy</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#getCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-">getCheckpointID</a></span>(org.apache.hadoop.mapreduce.v2.api.records.TaskId&nbsp;taskId)</code>
<div class="block">Method to retrieve the latest checkpoint for a given <code>TaskId</code></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#handleCompletedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">handleCompletedContainer</a></span>(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;attemptID)</code>
<div class="block">Callback informing the policy of containers exiting cleanly.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#handleFailedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">handleFailedContainer</a></span>(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;attemptID)</code>
<div class="block">Callback informing the policy of containers exiting with a failure.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#init-org.apache.hadoop.mapreduce.v2.app.AppContext-">init</a></span>(<a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/AppContext.html" title="interface in org.apache.hadoop.mapreduce.v2.app">AppContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#isPreempted-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">isPreempted</a></span>(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;yarnAttemptID)</code>
<div class="block">This method is invoked by components interested to learn whether a certain
task is being preempted.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#preempt-org.apache.hadoop.mapreduce.v2.app.rm.preemption.AMPreemptionPolicy.Context-org.apache.hadoop.yarn.api.records.PreemptionMessage-">preempt</a></span>(<a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.Context.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy.Context</a>&nbsp;ctxt,
org.apache.hadoop.yarn.api.records.PreemptionMessage&nbsp;preemptionRequests)</code>
<div class="block">Callback informing the policy of ResourceManager.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#reportSuccessfulPreemption-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">reportSuccessfulPreemption</a></span>(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;taskAttemptID)</code>
<div class="block">This method is used to report to the policy that a certain task has been
successfully preempted (for bookeeping, counters, etc..)</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html#setCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID-">setCheckpointID</a></span>(org.apache.hadoop.mapreduce.v2.api.records.TaskId&nbsp;taskId,
org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID&nbsp;cid)</code>
<div class="block">Method to store the latest <code>CheckpointID</code> for a given <code>TaskId</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CheckpointAMPreemptionPolicy--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CheckpointAMPreemptionPolicy</h4>
<pre>public&nbsp;CheckpointAMPreemptionPolicy()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-org.apache.hadoop.mapreduce.v2.app.AppContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/AppContext.html" title="interface in org.apache.hadoop.mapreduce.v2.app">AppContext</a>&nbsp;context)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#init-org.apache.hadoop.mapreduce.v2.app.AppContext-">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="preempt-org.apache.hadoop.mapreduce.v2.app.rm.preemption.AMPreemptionPolicy.Context-org.apache.hadoop.yarn.api.records.PreemptionMessage-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preempt</h4>
<pre>public&nbsp;void&nbsp;preempt(<a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.Context.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy.Context</a>&nbsp;ctxt,
org.apache.hadoop.yarn.api.records.PreemptionMessage&nbsp;preemptionRequests)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#preempt-org.apache.hadoop.mapreduce.v2.app.rm.preemption.AMPreemptionPolicy.Context-org.apache.hadoop.yarn.api.records.PreemptionMessage-">AMPreemptionPolicy</a></code></span></div>
<div class="block">Callback informing the policy of ResourceManager. requests for resources
to return to the cluster. The policy may take arbitrary action to satisfy
requests by checkpointing task state, returning containers, or ignoring
requests. The RM may elect to enforce these requests by forcibly killing
containers not returned after some duration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#preempt-org.apache.hadoop.mapreduce.v2.app.rm.preemption.AMPreemptionPolicy.Context-org.apache.hadoop.yarn.api.records.PreemptionMessage-">preempt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctxt</code> - Handle to the current state of running containers</dd>
<dd><code>preemptionRequests</code> - Request from RM for resources to return.</dd>
</dl>
</li>
</ul>
<a name="handleFailedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleFailedContainer</h4>
<pre>public&nbsp;void&nbsp;handleFailedContainer(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;attemptID)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#handleFailedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">AMPreemptionPolicy</a></code></span></div>
<div class="block">Callback informing the policy of containers exiting with a failure. This
allows the policy to implemnt cleanup/compensating actions.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#handleFailedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">handleFailedContainer</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attemptID</code> - Task attempt that failed</dd>
</dl>
</li>
</ul>
<a name="handleCompletedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleCompletedContainer</h4>
<pre>public&nbsp;void&nbsp;handleCompletedContainer(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;attemptID)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#handleCompletedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">AMPreemptionPolicy</a></code></span></div>
<div class="block">Callback informing the policy of containers exiting cleanly. This is
reported to the policy for bookeeping purposes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#handleCompletedContainer-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">handleCompletedContainer</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attemptID</code> - Task attempt that completed</dd>
</dl>
</li>
</ul>
<a name="isPreempted-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPreempted</h4>
<pre>public&nbsp;boolean&nbsp;isPreempted(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;yarnAttemptID)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#isPreempted-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">AMPreemptionPolicy</a></code></span></div>
<div class="block">This method is invoked by components interested to learn whether a certain
task is being preempted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#isPreempted-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">isPreempted</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>yarnAttemptID</code> - Task attempt to query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this attempt is being preempted</dd>
</dl>
</li>
</ul>
<a name="reportSuccessfulPreemption-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reportSuccessfulPreemption</h4>
<pre>public&nbsp;void&nbsp;reportSuccessfulPreemption(org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId&nbsp;taskAttemptID)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#reportSuccessfulPreemption-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">AMPreemptionPolicy</a></code></span></div>
<div class="block">This method is used to report to the policy that a certain task has been
successfully preempted (for bookeeping, counters, etc..)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#reportSuccessfulPreemption-org.apache.hadoop.mapreduce.v2.api.records.TaskAttemptId-">reportSuccessfulPreemption</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>taskAttemptID</code> - Task attempt that preempted</dd>
</dl>
</li>
</ul>
<a name="getCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckpointID</h4>
<pre>public&nbsp;org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID&nbsp;getCheckpointID(org.apache.hadoop.mapreduce.v2.api.records.TaskId&nbsp;taskId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#getCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-">AMPreemptionPolicy</a></code></span></div>
<div class="block">Method to retrieve the latest checkpoint for a given <code>TaskId</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#getCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-">getCheckpointID</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>taskId</code> - TaskID</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CheckpointID associated with this task or null</dd>
</dl>
</li>
</ul>
<a name="setCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCheckpointID</h4>
<pre>public&nbsp;void&nbsp;setCheckpointID(org.apache.hadoop.mapreduce.v2.api.records.TaskId&nbsp;taskId,
org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID&nbsp;cid)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#setCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID-">AMPreemptionPolicy</a></code></span></div>
<div class="block">Method to store the latest <code>CheckpointID</code> for a given <code>TaskId</code>. Assigning a null is akin to remove all previous checkpoints for
this task.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html#setCheckpointID-org.apache.hadoop.mapreduce.v2.api.records.TaskId-org.apache.hadoop.mapreduce.checkpoint.TaskCheckpointID-">setCheckpointID</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.html" title="interface in org.apache.hadoop.mapreduce.v2.app.rm.preemption">AMPreemptionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>taskId</code> - TaskID</dd>
<dd><code>cid</code> - Checkpoint to assign or <tt>null</tt> to remove it.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CheckpointAMPreemptionPolicy.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/mapreduce/v2/app/rm/preemption/AMPreemptionPolicy.Context.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/mapreduce/v2/app/rm/preemption/KillAMPreemptionPolicy.html" title="class in org.apache.hadoop.mapreduce.v2.app.rm.preemption"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/mapreduce/v2/app/rm/preemption/CheckpointAMPreemptionPolicy.html" target="_top">Frames</a></li>
<li><a href="CheckpointAMPreemptionPolicy.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>