blob: 9c59b3acfa100c96f4e3e668ff55a53763107dc2 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:12:40 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMClientImpl (Apache Hadoop YARN Client 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="NMClientImpl (Apache Hadoop YARN Client 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/NMClientImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/ContainerManagementProtocolProxy.ContainerManagementProtocolProxyData.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.StartedContainer.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html" target="_top">Frames</a></li>
<li><a href="NMClientImpl.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.yarn.client.api.impl</div>
<h2 title="Class NMClientImpl" class="title">Class NMClientImpl</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.service.AbstractService</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">org.apache.hadoop.yarn.client.api.NMClient</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.client.api.impl.NMClientImpl</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, org.apache.hadoop.service.Service</dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public class <span class="typeNameLabel">NMClientImpl</span>
extends <a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></pre>
<div class="block"><p>
This class implements <a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMClient</code></a>. All the APIs are blocking.
</p>
<p>
By default, this client stops all the running containers that are started by
it when it stops. It can be disabled via
<a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#cleanupRunningContainersOnStop-boolean-"><code>cleanupRunningContainersOnStop(boolean)</code></a>, in which case containers will
continue to run even after this client is stopped and till the application
runs at which point ResourceManager will forcefully kill them.
</p>
<p>
Note that the blocking APIs ensure the RPC calls to <code>NodeManager</code>
are executed immediately, and the responses are received before these APIs
return. However, when <a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#startContainer-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-"><code>startContainer(org.apache.hadoop.yarn.api.records.Container, org.apache.hadoop.yarn.api.records.ContainerLaunchContext)</code></a> or <a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#stopContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-"><code>stopContainer(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.NodeId)</code></a>
returns, <code>NodeManager</code> may still need some time to either start
or stop the container because of its asynchronous implementation. Therefore,
<a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#getContainerStatus-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-"><code>getContainerStatus(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.NodeId)</code></a> is likely to return a transit container status
if it is executed immediately after <a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#startContainer-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-"><code>startContainer(org.apache.hadoop.yarn.api.records.Container, org.apache.hadoop.yarn.api.records.ContainerLaunchContext)</code></a> or
<a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#stopContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-"><code>stopContainer(org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.NodeId)</code></a>.
</p></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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.StartedContainer.html" title="class in org.apache.hadoop.yarn.client.api.impl">NMClientImpl.StartedContainer</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.yarn.client.api.NMClient">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.hadoop.yarn.client.api.<a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></h3>
<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.UpgradeOp.html" title="enum in org.apache.hadoop.yarn.client.api">NMClient.UpgradeOp</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.service.Service">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.hadoop.service.Service</h3>
<code>org.apache.hadoop.service.Service.STATE</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a>&lt;org.apache.hadoop.yarn.api.records.ContainerId,<a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.StartedContainer.html" title="class in org.apache.hadoop.yarn.client.api.impl">NMClientImpl.StartedContainer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#startedContainers">startedContainers</a></span></code>&nbsp;</td>
</tr>
</table>
</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/yarn/client/api/impl/NMClientImpl.html#NMClientImpl--">NMClientImpl</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#NMClientImpl-java.lang.String-">NMClientImpl</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;name)</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#cleanupRunningContainers--">cleanupRunningContainers</a></span>()</code>&nbsp;</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/yarn/client/api/impl/NMClientImpl.html#cleanupRunningContainersOnStop-boolean-">cleanupRunningContainersOnStop</a></span>(boolean&nbsp;enabled)</code>
<div class="block">Set whether the containers that are started by this client, and are
still running should be stopped when the client stops.</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/yarn/client/api/impl/NMClientImpl.html#commitLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">commitLastReInitialization</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">Commit last reInitialization of the specified container.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#getCleanupRunningContainers--">getCleanupRunningContainers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.ContainerStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#getContainerStatus-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">getContainerStatus</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId)</code>
<div class="block">Query the status of a container.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><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.LocalizationStatus&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#getLocalizationStatuses-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">getLocalizationStatuses</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId)</code>
<div class="block">Get the localization statuses of a container.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.NodeId</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#getNodeIdOfStartedContainer-org.apache.hadoop.yarn.api.records.ContainerId-">getNodeIdOfStartedContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">Get the NodeId of the node on which container is running.</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/yarn/client/api/impl/NMClientImpl.html#increaseContainerResource-org.apache.hadoop.yarn.api.records.Container-">increaseContainerResource</a></span>(org.apache.hadoop.yarn.api.records.Container&nbsp;container)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#localize-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.util.Map-">localize</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,org.apache.hadoop.yarn.api.records.LocalResource&gt;&nbsp;localResources)</code>
<div class="block">Localize resources for a container.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#reInitializeContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-boolean-">reInitializeContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.ContainerLaunchContext&nbsp;containerLaunchContex,
boolean&nbsp;autoCommit)</code>
<div class="block">Re-Initialize the Container.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#restartContainer-org.apache.hadoop.yarn.api.records.ContainerId-">restartContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">Restart the specified container.</div>
</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/hadoop/yarn/client/api/impl/NMClientImpl.html#rollbackLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">rollbackLastReInitialization</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">Rollback last reInitialization of the specified container.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#serviceInit-org.apache.hadoop.conf.Configuration-">serviceInit</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#serviceStop--">serviceStop</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html#startContainer-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-">startContainer</a></span>(org.apache.hadoop.yarn.api.records.Container&nbsp;container,
org.apache.hadoop.yarn.api.records.ContainerLaunchContext&nbsp;containerLaunchContext)</code>
<div class="block">Start an allocated container.</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/hadoop/yarn/client/api/impl/NMClientImpl.html#stopContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">stopContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId)</code>
<div class="block">Stop an started container.</div>
</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/hadoop/yarn/client/api/impl/NMClientImpl.html#updateContainerResource-org.apache.hadoop.yarn.api.records.Container-">updateContainerResource</a></span>(org.apache.hadoop.yarn.api.records.Container&nbsp;container)</code>
<div class="block">Update the resources of a container.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.client.api.NMClient">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.yarn.client.api.<a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></h3>
<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#createNMClient--">createNMClient</a>, <a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#createNMClient-java.lang.String-">createNMClient</a>, <a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getNMTokenCache--">getNMTokenCache</a>, <a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#setNMTokenCache-org.apache.hadoop.yarn.client.api.NMTokenCache-">setNMTokenCache</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.service.AbstractService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.service.AbstractService</h3>
<code>close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceStart, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop</code></li>
</ul>
<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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="startedContainers">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>startedContainers</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a>&lt;org.apache.hadoop.yarn.api.records.ContainerId,<a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.StartedContainer.html" title="class in org.apache.hadoop.yarn.client.api.impl">NMClientImpl.StartedContainer</a>&gt; startedContainers</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NMClientImpl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NMClientImpl</h4>
<pre>public&nbsp;NMClientImpl()</pre>
</li>
</ul>
<a name="NMClientImpl-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NMClientImpl</h4>
<pre>public&nbsp;NMClientImpl(<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;name)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="serviceStop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serviceStop</h4>
<pre>protected&nbsp;void&nbsp;serviceStop()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>serviceStop</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.service.AbstractService</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="cleanupRunningContainers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanupRunningContainers</h4>
<pre>protected&nbsp;void&nbsp;cleanupRunningContainers()</pre>
</li>
</ul>
<a name="serviceInit-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serviceInit</h4>
<pre>protected&nbsp;void&nbsp;serviceInit(org.apache.hadoop.conf.Configuration&nbsp;conf)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>serviceInit</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.service.AbstractService</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="cleanupRunningContainersOnStop-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanupRunningContainersOnStop</h4>
<pre>public&nbsp;void&nbsp;cleanupRunningContainersOnStop(boolean&nbsp;enabled)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#cleanupRunningContainersOnStop-boolean-">NMClient</a></code></span></div>
<div class="block"><p>Set whether the containers that are started by this client, and are
still running should be stopped when the client stops. By default, the
feature should be enabled.</p> However, containers will be stopped only
when service is stopped. i.e. after <code>AbstractService.stop()</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#cleanupRunningContainersOnStop-boolean-">cleanupRunningContainersOnStop</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabled</code> - whether the feature is enabled or not</dd>
</dl>
</li>
</ul>
<a name="startContainer-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startContainer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&gt;&nbsp;startContainer(org.apache.hadoop.yarn.api.records.Container&nbsp;container,
org.apache.hadoop.yarn.api.records.ContainerLaunchContext&nbsp;containerLaunchContext)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#startContainer-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-">NMClient</a></code></span></div>
<div class="block"><p>Start an allocated container.</p>
<p>The <code>ApplicationMaster</code> or other applications that use the
client must provide the details of the allocated container, including the
Id, the assigned node's Id and the token via <code>Container</code>. In
addition, the AM needs to provide the <code>ContainerLaunchContext</code> as
well.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#startContainer-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-">startContainer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - the allocated container</dd>
<dd><code>containerLaunchContext</code> - the context information needed by the
<code>NodeManager</code> to launch the
container</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map between the auxiliary service names and their outputs</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="increaseContainerResource-org.apache.hadoop.yarn.api.records.Container-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>increaseContainerResource</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;increaseContainerResource(org.apache.hadoop.yarn.api.records.Container&nbsp;container)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#increaseContainerResource-org.apache.hadoop.yarn.api.records.Container-">NMClient</a></code></span></div>
<div class="block"><p>Increase the resource of a container.</p>
<p>The <code>ApplicationMaster</code> or other applications that use the
client must provide the details of the container, including the Id and
the target resource encapsulated in the updated container token via
<code>Container</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#increaseContainerResource-org.apache.hadoop.yarn.api.records.Container-">increaseContainerResource</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - the container with updated token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="updateContainerResource-org.apache.hadoop.yarn.api.records.Container-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateContainerResource</h4>
<pre>public&nbsp;void&nbsp;updateContainerResource(org.apache.hadoop.yarn.api.records.Container&nbsp;container)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#updateContainerResource-org.apache.hadoop.yarn.api.records.Container-">NMClient</a></code></span></div>
<div class="block"><p>Update the resources of a container.</p>
<p>The <code>ApplicationMaster</code> or other applications that use the
client must provide the details of the container, including the Id and
the target resource encapsulated in the updated container token via
<code>Container</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#updateContainerResource-org.apache.hadoop.yarn.api.records.Container-">updateContainerResource</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - the container with updated token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="stopContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopContainer</h4>
<pre>public&nbsp;void&nbsp;stopContainer(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#stopContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">NMClient</a></code></span></div>
<div class="block"><p>Stop an started container.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#stopContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">stopContainer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the started container</dd>
<dd><code>nodeId</code> - the Id of the <code>NodeManager</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="getContainerStatus-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerStatus</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.ContainerStatus&nbsp;getContainerStatus(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getContainerStatus-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">NMClient</a></code></span></div>
<div class="block"><p>Query the status of a container.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getContainerStatus-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">getContainerStatus</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the started container</dd>
<dd><code>nodeId</code> - the Id of the <code>NodeManager</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the status of a container.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="reInitializeContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reInitializeContainer</h4>
<pre>public&nbsp;void&nbsp;reInitializeContainer(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.ContainerLaunchContext&nbsp;containerLaunchContex,
boolean&nbsp;autoCommit)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#reInitializeContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-boolean-">NMClient</a></code></span></div>
<div class="block"><p>Re-Initialize the Container.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#reInitializeContainer-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.ContainerLaunchContext-boolean-">reInitializeContainer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the container to Re-Initialize.</dd>
<dd><code>containerLaunchContex</code> - the updated ContainerLaunchContext.</dd>
<dd><code>autoCommit</code> - commit re-initialization automatically ?</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="restartContainer-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restartContainer</h4>
<pre>public&nbsp;void&nbsp;restartContainer(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#restartContainer-org.apache.hadoop.yarn.api.records.ContainerId-">NMClient</a></code></span></div>
<div class="block"><p>Restart the specified container.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#restartContainer-org.apache.hadoop.yarn.api.records.ContainerId-">restartContainer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the container to restart.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="rollbackLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rollbackLastReInitialization</h4>
<pre>public&nbsp;void&nbsp;rollbackLastReInitialization(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#rollbackLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">NMClient</a></code></span></div>
<div class="block"><p>Rollback last reInitialization of the specified container.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#rollbackLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">rollbackLastReInitialization</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the container to restart.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="commitLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commitLastReInitialization</h4>
<pre>public&nbsp;void&nbsp;commitLastReInitialization(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#commitLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">NMClient</a></code></span></div>
<div class="block"><p>Commit last reInitialization of the specified container.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#commitLastReInitialization-org.apache.hadoop.yarn.api.records.ContainerId-">commitLastReInitialization</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the container to commit reInitialize.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</dd>
</dl>
</li>
</ul>
<a name="getCleanupRunningContainers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCleanupRunningContainers</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a>&nbsp;getCleanupRunningContainers()</pre>
</li>
</ul>
<a name="getNodeIdOfStartedContainer-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeIdOfStartedContainer</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.NodeId&nbsp;getNodeIdOfStartedContainer(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getNodeIdOfStartedContainer-org.apache.hadoop.yarn.api.records.ContainerId-">NMClient</a></code></span></div>
<div class="block">Get the NodeId of the node on which container is running. It returns
null if the container if container is not found or if it is not running.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getNodeIdOfStartedContainer-org.apache.hadoop.yarn.api.records.ContainerId-">getNodeIdOfStartedContainer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - Container Id of the container.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>NodeId of the container on which it is running.</dd>
</dl>
</li>
</ul>
<a name="localize-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localize</h4>
<pre>public&nbsp;void&nbsp;localize(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,org.apache.hadoop.yarn.api.records.LocalResource&gt;&nbsp;localResources)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#localize-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.util.Map-">NMClient</a></code></span></div>
<div class="block">Localize resources for a container.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#localize-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.util.Map-">localize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the ID of the container</dd>
<dd><code>nodeId</code> - node Id of the container</dd>
<dd><code>localResources</code> - resources to localize</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getLocalizationStatuses-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocalizationStatuses</h4>
<pre>public&nbsp;<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.LocalizationStatus&gt;&nbsp;getLocalizationStatuses(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId,
org.apache.hadoop.yarn.api.records.NodeId&nbsp;nodeId)
throws org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getLocalizationStatuses-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">NMClient</a></code></span></div>
<div class="block">Get the localization statuses of a container.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html#getLocalizationStatuses-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-">getLocalizationStatuses</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api">NMClient</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - the Id of the container</dd>
<dd><code>nodeId</code> - node Id of the container</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the status of a container.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - YarnException.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - IOException.</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/NMClientImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/ContainerManagementProtocolProxy.ContainerManagementProtocolProxyData.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/NMClientImpl.StartedContainer.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/client/api/impl/NMClientImpl.html" target="_top">Frames</a></li>
<li><a href="NMClientImpl.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>