Google Git
Sign in
apache / incubator-nemo-website / ee5ccb31dfe6523e6550f715cbf4913d9db75dcc / . / apidocs / org / apache / nemo / runtime / master / PlanStateManager.html
blob: af46b7fdffb657f41f61020f7a4d0454505ed80e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 -->
<title>PlanStateManager (Nemo Project 0.4 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PlanStateManager (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PlanStateManager.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.nemo.runtime.master</a></div>
<h2 title="Class PlanStateManager" class="title">Class PlanStateManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.nemo.runtime.master.PlanStateManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>@ThreadSafe
public final class <span class="typeNameLabel">PlanStateManager</span>
extends java.lang.Object</pre>
<div class="block">Maintains three levels of state machines (PlanState, StageState, and TaskState) of a physical plan.
The main API this class provides is onTaskStateReportFromExecutor(), which directly changes a TaskState.
PlanState and StageState are updated internally in the class, and can only be read from the outside.
<p>
(CONCURRENCY) The public methods of this class are synchronized.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;<a href="../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllTaskAttemptIdsToItsState()">getAllTaskAttemptIdsToItsState</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllTaskAttemptsOfStage(java.lang.String)">getAllTaskAttemptsOfStage</a></span>&#8203;(java.lang.String&nbsp;stageId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Long&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompletedTaskTimeListMs(java.lang.String)">getCompletedTaskTimeListMs</a></span>&#8203;(java.lang.String&nbsp;stageId)</code></th>
<td class="colLast">
<div class="block">List of task times so far for this stage.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Long&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutingTaskToRunningTimeMs(java.lang.String)">getExecutingTaskToRunningTimeMs</a></span>&#8203;(java.lang.String&nbsp;stageId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxScheduleAttempt()">getMaxScheduleAttempt</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPhysicalPlan()">getPhysicalPlan</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlanId()">getPlanId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../common/state/PlanState.State.html" title="enum in org.apache.nemo.runtime.common.state">PlanState.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlanState()">getPlanState</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../common/state/StageState.State.html" title="enum in org.apache.nemo.runtime.common.state">StageState.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStageState(java.lang.String)">getStageState</a></span>&#8203;(java.lang.String&nbsp;stageId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTaskAttemptsToSchedule(java.lang.String)">getTaskAttemptsToSchedule</a></span>&#8203;(java.lang.String&nbsp;stageId)</code></th>
<td class="colLast">
<div class="block">Get task attempts that are "READY".</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTaskState(java.lang.String)">getTaskState</a></span>&#8203;(java.lang.String&nbsp;taskId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInitialized()">isInitialized</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPlanDone()">isPlanDone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="PlanStateManager.html" title="class in org.apache.nemo.runtime.master">PlanStateManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newInstance(java.lang.String)">newInstance</a></span>&#8203;(java.lang.String&nbsp;dagDirectory)</code></th>
<td class="colLast">
<div class="block">Static constructor for manual usage.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onTaskStateChanged(java.lang.String,org.apache.nemo.runtime.common.state.TaskState.State)">onTaskStateChanged</a></span>&#8203;(java.lang.String&nbsp;taskId,
<a href="../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a>&nbsp;newTaskState)</code></th>
<td class="colLast">
<div class="block">Updates the state of a task.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMetricStore(org.apache.nemo.runtime.master.metric.MetricStore)">setMetricStore</a></span>&#8203;(<a href="metric/MetricStore.html" title="class in org.apache.nemo.runtime.master.metric">MetricStore</a>&nbsp;metricStore)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNumOfClones(java.lang.String,int,int)">setNumOfClones</a></span>&#8203;(java.lang.String&nbsp;stageId,
int&nbsp;taskIndex,
int&nbsp;numOfClones)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeJSON(java.lang.String)">storeJSON</a></span>&#8203;(java.lang.String&nbsp;suffix)</code></th>
<td class="colLast">
<div class="block">Stores JSON representation of plan state into a file.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updatePlan(org.apache.nemo.runtime.common.plan.PhysicalPlan,int)">updatePlan</a></span>&#8203;(<a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a>&nbsp;physicalPlanToUpdate,
int&nbsp;maxScheduleAttemptToSet)</code></th>
<td class="colLast">
<div class="block">Update the physical plan and maximum attempt.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../common/state/PlanState.State.html" title="enum in org.apache.nemo.runtime.common.state">PlanState.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#waitUntilFinish()">waitUntilFinish</a></span>()</code></th>
<td class="colLast">
<div class="block">Wait for this plan to be finished and return the final state.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../common/state/PlanState.State.html" title="enum in org.apache.nemo.runtime.common.state">PlanState.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#waitUntilFinish(long,java.util.concurrent.TimeUnit)">waitUntilFinish</a></span>&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Wait for this plan to be finished and return the final state.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="newInstance(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="PlanStateManager.html" title="class in org.apache.nemo.runtime.master">PlanStateManager</a>&nbsp;newInstance&#8203;(java.lang.String&nbsp;dagDirectory)</pre>
<div class="block">Static constructor for manual usage.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dagDirectory</code> - the DAG directory to store the JSON to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new PlanStateManager instance.</dd>
</dl>
</li>
</ul>
<a id="setMetricStore(org.apache.nemo.runtime.master.metric.MetricStore)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricStore</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMetricStore&#8203;(<a href="metric/MetricStore.html" title="class in org.apache.nemo.runtime.master.metric">MetricStore</a>&nbsp;metricStore)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metricStore</code> - set the metric store of the paln state manager.</dd>
</dl>
</li>
</ul>
<a id="updatePlan(org.apache.nemo.runtime.common.plan.PhysicalPlan,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updatePlan</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updatePlan&#8203;(<a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a>&nbsp;physicalPlanToUpdate,
int&nbsp;maxScheduleAttemptToSet)</pre>
<div class="block">Update the physical plan and maximum attempt.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>physicalPlanToUpdate</code> - the physical plan to manage.</dd>
<dd><code>maxScheduleAttemptToSet</code> - the maximum number of times this plan/sub-part of the plan should be attempted.</dd>
</dl>
</li>
</ul>
<a id="getTaskAttemptsToSchedule(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTaskAttemptsToSchedule</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getTaskAttemptsToSchedule&#8203;(java.lang.String&nbsp;stageId)</pre>
<div class="block">Get task attempts that are "READY".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stageId</code> - to run</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>executable task attempts</dd>
</dl>
</li>
</ul>
<a id="getAllTaskAttemptsOfStage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllTaskAttemptsOfStage</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getAllTaskAttemptsOfStage&#8203;(java.lang.String&nbsp;stageId)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stageId</code> - to query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all task attempt ids of the stage.</dd>
</dl>
</li>
</ul>
<a id="getExecutingTaskToRunningTimeMs(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutingTaskToRunningTimeMs</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.Long&gt;&nbsp;getExecutingTaskToRunningTimeMs&#8203;(java.lang.String&nbsp;stageId)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stageId</code> - to query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map from an EXECUTING task to its running time so far.</dd>
</dl>
</li>
</ul>
<a id="getCompletedTaskTimeListMs(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletedTaskTimeListMs</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.Long&gt;&nbsp;getCompletedTaskTimeListMs&#8203;(java.lang.String&nbsp;stageId)</pre>
<div class="block">List of task times so far for this stage.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stageId</code> - of the stage.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of the list, empty if none completed.</dd>
</dl>
</li>
</ul>
<a id="setNumOfClones(java.lang.String,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumOfClones</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;setNumOfClones&#8203;(java.lang.String&nbsp;stageId,
int&nbsp;taskIndex,
int&nbsp;numOfClones)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stageId</code> - of the clone.</dd>
<dd><code>taskIndex</code> - of the clone.</dd>
<dd><code>numOfClones</code> - of the clone.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the numOfClones has been modified, false otherwise</dd>
</dl>
</li>
</ul>
<a id="onTaskStateChanged(java.lang.String,org.apache.nemo.runtime.common.state.TaskState.State)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onTaskStateChanged</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onTaskStateChanged&#8203;(java.lang.String&nbsp;taskId,
<a href="../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a>&nbsp;newTaskState)</pre>
<div class="block">Updates the state of a task.
Task state changes can occur both in master and executor.
State changes that occur in master are
initiated in <a href="scheduler/BatchScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler"><code>BatchScheduler</code></a>.
State changes that occur in executors are sent to master as a control message,
and the call to this method is initiated in <a href="scheduler/BatchScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler"><code>BatchScheduler</code></a>
when the message/event is received.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>taskId</code> - the ID of the task.</dd>
<dd><code>newTaskState</code> - the new state of the task.</dd>
</dl>
</li>
</ul>
<a id="waitUntilFinish()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitUntilFinish</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/state/PlanState.State.html" title="enum in org.apache.nemo.runtime.common.state">PlanState.State</a>&nbsp;waitUntilFinish()</pre>
<div class="block">Wait for this plan to be finished and return the final state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the final state of this plan.</dd>
</dl>
</li>
</ul>
<a id="waitUntilFinish(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitUntilFinish</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/state/PlanState.State.html" title="enum in org.apache.nemo.runtime.common.state">PlanState.State</a>&nbsp;waitUntilFinish&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</pre>
<div class="block">Wait for this plan to be finished and return the final state.
It wait for at most the given time.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - of waiting.</dd>
<dd><code>unit</code> - of the timeout.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the final state of this plan.</dd>
</dl>
</li>
</ul>
<a id="getAllTaskAttemptIdsToItsState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllTaskAttemptIdsToItsState</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a>&gt;&nbsp;getAllTaskAttemptIdsToItsState()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map from task attempt id to its current state.</dd>
</dl>
</li>
</ul>
<a id="isPlanDone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPlanDone</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isPlanDone()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the execution for the plan is done or not.</dd>
</dl>
</li>
</ul>
<a id="getPlanId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlanId</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getPlanId()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ID of the plan.</dd>
</dl>
</li>
</ul>
<a id="getPlanState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlanState</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/state/PlanState.State.html" title="enum in org.apache.nemo.runtime.common.state">PlanState.State</a>&nbsp;getPlanState()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state of the plan.</dd>
</dl>
</li>
</ul>
<a id="getStageState(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStageState</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/state/StageState.State.html" title="enum in org.apache.nemo.runtime.common.state">StageState.State</a>&nbsp;getStageState&#8203;(java.lang.String&nbsp;stageId)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stageId</code> - the stage ID to query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state of the stage.</dd>
</dl>
</li>
</ul>
<a id="getTaskState(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTaskState</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a>&nbsp;getTaskState&#8203;(java.lang.String&nbsp;taskId)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>taskId</code> - the ID of the task to query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state of the task.</dd>
</dl>
</li>
</ul>
<a id="getPhysicalPlan()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPhysicalPlan</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a>&nbsp;getPhysicalPlan()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the physical plan.</dd>
</dl>
</li>
</ul>
<a id="getMaxScheduleAttempt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxScheduleAttempt</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMaxScheduleAttempt()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of task scheduling.</dd>
</dl>
</li>
</ul>
<a id="isInitialized()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInitialized</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isInitialized()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether any plan has been submitted and initialized.</dd>
</dl>
</li>
</ul>
<a id="storeJSON(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeJSON</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;storeJSON&#8203;(java.lang.String&nbsp;suffix)</pre>
<div class="block">Stores JSON representation of plan state into a file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>suffix</code> - suffix for file name</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PlanStateManager.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>