Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / yarn / appMaster / ClusterController.html
blob: ed588d2a6fe73bae46f8b91d113d55164cad9669 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClusterController (Drill : 1.20.3 API)</title>
<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="ClusterController (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ClusterController.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/drill/yarn/appMaster/BatchScheduler.html" title="class in org.apache.drill.yarn.appMaster"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterControllerImpl.html" title="class in org.apache.drill.yarn.appMaster"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/yarn/appMaster/ClusterController.html" target="_top">Frames</a></li>
<li><a href="ClusterController.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>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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.yarn.appMaster</div>
<h2 title="Interface ClusterController" class="title">Interface ClusterController</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html" title="interface in org.apache.drill.yarn.appMaster">RegistryHandler</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterControllerImpl.html" title="class in org.apache.drill.yarn.appMaster">ClusterControllerImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClusterController</span>
extends <a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html" title="interface in org.apache.drill.yarn.appMaster">RegistryHandler</a></pre>
<div class="block">Interface which identifies the cluster controller methods that are save to
call from the <a href="../../../../../org/apache/drill/yarn/appMaster/Dispatcher.html" title="class in org.apache.drill.yarn.appMaster"><code>Dispatcher</code></a>. Methods here are either designed to be
called before the event threads start or after they complete. The remainder
synchronized to coordinate between event threads.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#cancelTask-int-">cancelTask</a></span>(int&nbsp;id)</code>
<div class="block">Cancels the given task, reducing the target task count.</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/drill/yarn/appMaster/ClusterController.html#containersAllocated-java.util.List-">containersAllocated</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.yarn.api.records.Container&gt;&nbsp;containers)</code>
<div class="block">The RM has allocated one or more containers in response to container
requests submitted to the RM.</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/drill/yarn/appMaster/ClusterController.html#containersCompleted-java.util.List-">containersCompleted</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.yarn.api.records.ContainerStatus&gt;&nbsp;statuses)</code>
<div class="block">The Resource Manager reports that containers have completed with the given
statuses.</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/drill/yarn/appMaster/ClusterController.html#containerStarted-org.apache.hadoop.yarn.api.records.ContainerId-">containerStarted</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">The NM reports that a container has successfully started.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#containerStopped-org.apache.hadoop.yarn.api.records.ContainerId-">containerStopped</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">The Node Manager reports that a container has stopped.</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/drill/yarn/appMaster/ClusterController.html#enableFailureCheck-boolean-">enableFailureCheck</a></span>(boolean&nbsp;flag)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#getFreeNodeCount--">getFreeNodeCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#getProgress--">getProgress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#getProperty-java.lang.String-">getProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#getTargetCount--">getTargetCount</a></span>()</code>
<div class="block">Return the target number of tasks that the controller seeks to maintain.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#isTaskLive-int-">isTaskLive</a></span>(int&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#registerLifecycleListener-org.apache.drill.yarn.appMaster.TaskLifecycleListener-">registerLifecycleListener</a></span>(<a href="../../../../../org/apache/drill/yarn/appMaster/TaskLifecycleListener.html" title="interface in org.apache.drill.yarn.appMaster">TaskLifecycleListener</a>&nbsp;listener)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#registerScheduler-org.apache.drill.yarn.appMaster.Scheduler-">registerScheduler</a></span>(<a href="../../../../../org/apache/drill/yarn/appMaster/Scheduler.html" title="interface in org.apache.drill.yarn.appMaster">Scheduler</a>&nbsp;resourceGroup)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#resizeDelta-int-">resizeDelta</a></span>(int&nbsp;delta)</code>
<div class="block">Request to resize the Drill cluster by a relative amount.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#resizeTo-int-">resizeTo</a></span>(int&nbsp;n)</code>
<div class="block">Request to resize the Drill cluster to the given size.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#setMaxRetries-int-">setMaxRetries</a></span>(int&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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>&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#shutDown--">shutDown</a></span>()</code>
<div class="block">Indicates a request to gracefully shut down the cluster.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#started--">started</a></span>()</code>
<div class="block">Called after the dispatcher has started YARN and other server
components.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#stopTaskFailed-org.apache.hadoop.yarn.api.records.ContainerId-java.lang.Throwable-">stopTaskFailed</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>
<div class="block">The Node Manager API reports that a request sent to the NM to stop a task
has failed.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#supportsDiskResource--">supportsDiskResource</a></span>()</code>
<div class="block">Whether this distribution of YARN supports disk resources.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#taskStartFailed-org.apache.hadoop.yarn.api.records.ContainerId-java.lang.Throwable-">taskStartFailed</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>
<div class="block">The RM API reports that an attempt to start a container has failed locally.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#tick-long-">tick</a></span>(long&nbsp;curTime)</code>
<div class="block">Called by the timer ("pulse") thread to trigger time-based events.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#updateRMStatus--">updateRMStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#visit-org.apache.drill.yarn.appMaster.ControllerVisitor-">visit</a></span>(<a href="../../../../../org/apache/drill/yarn/appMaster/ControllerVisitor.html" title="interface in org.apache.drill.yarn.appMaster">ControllerVisitor</a>&nbsp;visitor)</code>
<div class="block">Allow an observer to see a consistent view of the controller's
state by performing the visit in a synchronized block.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#visitTasks-org.apache.drill.yarn.appMaster.TaskVisitor-">visitTasks</a></span>(<a href="../../../../../org/apache/drill/yarn/appMaster/TaskVisitor.html" title="interface in org.apache.drill.yarn.appMaster">TaskVisitor</a>&nbsp;visitor)</code>
<div class="block">Allow an observer to see a consistent view of the controller's
task state by performing the visit in a synchronized block.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html#waitForCompletion--">waitForCompletion</a></span>()</code>
<div class="block">Called by the main thread to wait for the normal shutdown of the
controller.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.yarn.appMaster.RegistryHandler">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.yarn.appMaster.<a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html" title="interface in org.apache.drill.yarn.appMaster">RegistryHandler</a></h3>
<code><a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html#completionAck-org.apache.drill.yarn.appMaster.Task-java.lang.String-">completionAck</a>, <a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html#registryDown--">registryDown</a>, <a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html#releaseHost-java.lang.String-">releaseHost</a>, <a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html#reserveHost-java.lang.String-">reserveHost</a>, <a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html#startAck-org.apache.drill.yarn.appMaster.Task-java.lang.String-java.lang.Object-">startAck</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="enableFailureCheck-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableFailureCheck</h4>
<pre>void&nbsp;enableFailureCheck(boolean&nbsp;flag)</pre>
</li>
</ul>
<a name="registerLifecycleListener-org.apache.drill.yarn.appMaster.TaskLifecycleListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerLifecycleListener</h4>
<pre>void&nbsp;registerLifecycleListener(<a href="../../../../../org/apache/drill/yarn/appMaster/TaskLifecycleListener.html" title="interface in org.apache.drill.yarn.appMaster">TaskLifecycleListener</a>&nbsp;listener)</pre>
</li>
</ul>
<a name="registerScheduler-org.apache.drill.yarn.appMaster.Scheduler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerScheduler</h4>
<pre>void&nbsp;registerScheduler(<a href="../../../../../org/apache/drill/yarn/appMaster/Scheduler.html" title="interface in org.apache.drill.yarn.appMaster">Scheduler</a>&nbsp;resourceGroup)</pre>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>void&nbsp;setProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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>&nbsp;value)</pre>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre><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>&nbsp;getProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
</li>
</ul>
<a name="started--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>started</h4>
<pre>void&nbsp;started()
throws <a href="../../../../../org/apache/drill/yarn/appMaster/YarnFacadeException.html" title="class in org.apache.drill.yarn.appMaster">YarnFacadeException</a>,
<a href="../../../../../org/apache/drill/yarn/appMaster/AMException.html" title="class in org.apache.drill.yarn.appMaster">AMException</a></pre>
<div class="block">Called after the dispatcher has started YARN and other server
components. The controller can now begin to spin up tasks.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/yarn/appMaster/YarnFacadeException.html" title="class in org.apache.drill.yarn.appMaster">YarnFacadeException</a></code></dd>
<dd><code><a href="../../../../../org/apache/drill/yarn/appMaster/AMException.html" title="class in org.apache.drill.yarn.appMaster">AMException</a></code></dd>
</dl>
</li>
</ul>
<a name="tick-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tick</h4>
<pre>void&nbsp;tick(long&nbsp;curTime)</pre>
<div class="block">Called by the timer ("pulse") thread to trigger time-based events.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>curTime</code> - </dd>
</dl>
</li>
</ul>
<a name="containersAllocated-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containersAllocated</h4>
<pre>void&nbsp;containersAllocated(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.yarn.api.records.Container&gt;&nbsp;containers)</pre>
<div class="block">The RM has allocated one or more containers in response to container
requests submitted to the RM.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containers</code> - the set of containers provided by YARN</dd>
</dl>
</li>
</ul>
<a name="containerStarted-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containerStarted</h4>
<pre>void&nbsp;containerStarted(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</pre>
<div class="block">The NM reports that a container has successfully started.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the container which started</dd>
</dl>
</li>
</ul>
<a name="taskStartFailed-org.apache.hadoop.yarn.api.records.ContainerId-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>taskStartFailed</h4>
<pre>void&nbsp;taskStartFailed(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
<div class="block">The RM API reports that an attempt to start a container has failed locally.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the container that failed to launch</dd>
<dd><code>t</code> - the error that occurred</dd>
</dl>
</li>
</ul>
<a name="containerStopped-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containerStopped</h4>
<pre>void&nbsp;containerStopped(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</pre>
<div class="block">The Node Manager reports that a container has stopped.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - </dd>
</dl>
</li>
</ul>
<a name="containersCompleted-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containersCompleted</h4>
<pre>void&nbsp;containersCompleted(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.yarn.api.records.ContainerStatus&gt;&nbsp;statuses)</pre>
<div class="block">The Resource Manager reports that containers have completed with the given
statuses. Find the task for each container and mark them as completed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statuses</code> - </dd>
</dl>
</li>
</ul>
<a name="getProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgress</h4>
<pre>float&nbsp;getProgress()</pre>
</li>
</ul>
<a name="stopTaskFailed-org.apache.hadoop.yarn.api.records.ContainerId-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopTaskFailed</h4>
<pre>void&nbsp;stopTaskFailed(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
<div class="block">The Node Manager API reports that a request sent to the NM to stop a task
has failed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the container that failed to stop</dd>
<dd><code>t</code> - the reason that the stop request failed</dd>
</dl>
</li>
</ul>
<a name="resizeDelta-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resizeDelta</h4>
<pre>void&nbsp;resizeDelta(int&nbsp;delta)</pre>
<div class="block">Request to resize the Drill cluster by a relative amount.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>delta</code> - the amount of change. Can be positive (to grow) or negative (to
shrink the cluster)</dd>
</dl>
</li>
</ul>
<a name="resizeTo-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resizeTo</h4>
<pre>int&nbsp;resizeTo(int&nbsp;n)</pre>
<div class="block">Request to resize the Drill cluster to the given size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the desired cluster size</dd>
</dl>
</li>
</ul>
<a name="shutDown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutDown</h4>
<pre>void&nbsp;shutDown()</pre>
<div class="block">Indicates a request to gracefully shut down the cluster.</div>
</li>
</ul>
<a name="waitForCompletion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitForCompletion</h4>
<pre>boolean&nbsp;waitForCompletion()</pre>
<div class="block">Called by the main thread to wait for the normal shutdown of the
controller. Such shutdown occurs when the admin sends a sutdown
command from the UI or REST API.</div>
</li>
</ul>
<a name="updateRMStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateRMStatus</h4>
<pre>void&nbsp;updateRMStatus()</pre>
</li>
</ul>
<a name="setMaxRetries-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxRetries</h4>
<pre>void&nbsp;setMaxRetries(int&nbsp;value)</pre>
</li>
</ul>
<a name="visit-org.apache.drill.yarn.appMaster.ControllerVisitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visit</h4>
<pre>void&nbsp;visit(<a href="../../../../../org/apache/drill/yarn/appMaster/ControllerVisitor.html" title="interface in org.apache.drill.yarn.appMaster">ControllerVisitor</a>&nbsp;visitor)</pre>
<div class="block">Allow an observer to see a consistent view of the controller's
state by performing the visit in a synchronized block.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - </dd>
</dl>
</li>
</ul>
<a name="visitTasks-org.apache.drill.yarn.appMaster.TaskVisitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitTasks</h4>
<pre>void&nbsp;visitTasks(<a href="../../../../../org/apache/drill/yarn/appMaster/TaskVisitor.html" title="interface in org.apache.drill.yarn.appMaster">TaskVisitor</a>&nbsp;visitor)</pre>
<div class="block">Allow an observer to see a consistent view of the controller's
task state by performing the visit in a synchronized block.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - </dd>
</dl>
</li>
</ul>
<a name="getTargetCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetCount</h4>
<pre>int&nbsp;getTargetCount()</pre>
<div class="block">Return the target number of tasks that the controller seeks to maintain.
This is the sum across all pools.</div>
</li>
</ul>
<a name="isTaskLive-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTaskLive</h4>
<pre>boolean&nbsp;isTaskLive(int&nbsp;id)</pre>
</li>
</ul>
<a name="cancelTask-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelTask</h4>
<pre>boolean&nbsp;cancelTask(int&nbsp;id)</pre>
<div class="block">Cancels the given task, reducing the target task count. Called
from the UI to allow the user to select the specific task to end
when reducing cluster size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - </dd>
</dl>
</li>
</ul>
<a name="supportsDiskResource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsDiskResource</h4>
<pre>boolean&nbsp;supportsDiskResource()</pre>
<div class="block">Whether this distribution of YARN supports disk resources.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if this distribution of YARN supports disk resources. False otherwise.</dd>
</dl>
</li>
</ul>
<a name="getFreeNodeCount--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFreeNodeCount</h4>
<pre>int&nbsp;getFreeNodeCount()</pre>
</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/ClusterController.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/drill/yarn/appMaster/BatchScheduler.html" title="class in org.apache.drill.yarn.appMaster"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterControllerImpl.html" title="class in org.apache.drill.yarn.appMaster"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/yarn/appMaster/ClusterController.html" target="_top">Frames</a></li>
<li><a href="ClusterController.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>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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>