blob: 2c53f4275e7d0e166ec9a95ba3b4567773974583 [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>NMTokenCache (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="NMTokenCache (Apache Hadoop YARN Client 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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/NMTokenCache.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/NMClient.UpgradeOp.html" title="enum in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/yarn/client/api/SharedCacheClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/client/api/NMTokenCache.html" target="_top">Frames</a></li>
<li><a href="NMTokenCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.client.api</div>
<h2 title="Class NMTokenCache" class="title">Class NMTokenCache</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.yarn.client.api.NMTokenCache</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public class <span class="typeNameLabel">NMTokenCache</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">NMTokenCache manages NMTokens required for an Application Master
communicating with individual NodeManagers.
<p>
By default YARN client libraries <a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>AMRMClient</code></a> and <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMClient</code></a> use
<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--"><code>getSingleton()</code></a> instance of the cache.
<ul>
<li>
Using the singleton instance of the cache is appropriate when running a
single ApplicationMaster in the same JVM.
</li>
<li>
When using the singleton, users don't need to do anything special,
<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>AMRMClient</code></a> and <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMClient</code></a> are already set up to use the
default singleton <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMTokenCache</code></a>
</li>
</ul>
If running multiple Application Masters in the same JVM, a different cache
instance should be used for each Application Master.
<ul>
<li>
If using the <a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>AMRMClient</code></a> and the <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMClient</code></a>, setting up
and using an instance cache is as follows:
<pre>
NMTokenCache nmTokenCache = new NMTokenCache();
AMRMClient rmClient = AMRMClient.createAMRMClient();
NMClient nmClient = NMClient.createNMClient();
nmClient.setNMTokenCache(nmTokenCache);
...
</pre>
</li>
<li>
If using the <a href="../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async"><code>AMRMClientAsync</code></a> and the <a href="../../../../../../org/apache/hadoop/yarn/client/api/async/NMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async"><code>NMClientAsync</code></a>,
setting up and using an instance cache is as follows:
<pre>
NMTokenCache nmTokenCache = new NMTokenCache();
AMRMClient rmClient = AMRMClient.createAMRMClient();
NMClient nmClient = NMClient.createNMClient();
nmClient.setNMTokenCache(nmTokenCache);
AMRMClientAsync rmClientAsync = new AMRMClientAsync(rmClient, 1000, [AMRM_CALLBACK]);
NMClientAsync nmClientAsync = new NMClientAsync("nmClient", nmClient, [NM_CALLBACK]);
...
</pre>
</li>
<li>
If using <code>ApplicationMasterProtocol</code> and
<code>ContainerManagementProtocol</code> directly, setting up and using an
instance cache is as follows:
<pre>
NMTokenCache nmTokenCache = new NMTokenCache();
...
ApplicationMasterProtocol amPro = ClientRMProxy.createRMProxy(conf, ApplicationMasterProtocol.class);
...
AllocateRequest allocateRequest = ...
...
AllocateResponse allocateResponse = rmClient.allocate(allocateRequest);
for (NMToken token : allocateResponse.getNMTokens()) {
nmTokenCache.setToken(token.getNodeId().toString(), token.getToken());
}
...
ContainerManagementProtocolProxy nmPro = ContainerManagementProtocolProxy(conf, nmTokenCache);
...
nmPro.startContainer(container, containerContext);
...
</pre>
</li>
</ul>
It is also possible to mix the usage of a client (<code>AMRMClient</code> or
<code>NMClient</code>, or the async versions of them) with a protocol proxy
(<code>ContainerManagementProtocolProxy</code> or
<code>ApplicationMasterProtocol</code>).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/NMTokenCache.html#NMTokenCache--">NMTokenCache</a></span>()</code>
<div class="block">Creates a NM token cache instance.</div>
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#clearCache--">clearCache</a></span>()</code>
<div class="block">It will remove all the nm tokens from its cache</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#containsToken-java.lang.String-">containsToken</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;nodeAddr)</code>
<div class="block">Returns true if NMToken is present in cache.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static org.apache.hadoop.yarn.api.records.Token</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getNMToken-java.lang.String-">getNMToken</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;nodeAddr)</code>
<div class="block">Returns NMToken, null if absent.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api">NMTokenCache</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--">getSingleton</a></span>()</code>
<div class="block">Returns the singleton NM token cache.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Token</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getToken-java.lang.String-">getToken</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;nodeAddr)</code>
<div class="block">Returns NMToken, null if absent</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#numberOfTokensInCache--">numberOfTokensInCache</a></span>()</code>
<div class="block">Returns the number of NMTokens present in cache.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#removeToken-java.lang.String-">removeToken</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;nodeAddr)</code>
<div class="block">Removes NMToken for specified node manager</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#setNMToken-java.lang.String-org.apache.hadoop.yarn.api.records.Token-">setNMToken</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;nodeAddr,
org.apache.hadoop.yarn.api.records.Token&nbsp;token)</code>
<div class="block">Sets the NMToken for node address only in the singleton obtained from
<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--"><code>getSingleton()</code></a>.</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/NMTokenCache.html#setToken-java.lang.String-org.apache.hadoop.yarn.api.records.Token-">setToken</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;nodeAddr,
org.apache.hadoop.yarn.api.records.Token&nbsp;token)</code>
<div class="block">Sets the NMToken for node address</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NMTokenCache--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NMTokenCache</h4>
<pre>public&nbsp;NMTokenCache()</pre>
<div class="block">Creates a NM token cache instance.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSingleton--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSingleton</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api">NMTokenCache</a>&nbsp;getSingleton()</pre>
<div class="block">Returns the singleton NM token cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the singleton NM token cache.</dd>
</dl>
</li>
</ul>
<a name="getNMToken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNMToken</h4>
<pre>@InterfaceAudience.Public
public static&nbsp;org.apache.hadoop.yarn.api.records.Token&nbsp;getNMToken(<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;nodeAddr)</pre>
<div class="block">Returns NMToken, null if absent. Only the singleton obtained from
<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--"><code>getSingleton()</code></a> is looked at for the tokens. If you are using your
own NMTokenCache that is different from the singleton, use
<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getToken-java.lang.String-"><code>getToken(String)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeAddr</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Token</code> NMToken required for communicating with node manager</dd>
</dl>
</li>
</ul>
<a name="setNMToken-java.lang.String-org.apache.hadoop.yarn.api.records.Token-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNMToken</h4>
<pre>@InterfaceAudience.Public
public static&nbsp;void&nbsp;setNMToken(<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;nodeAddr,
org.apache.hadoop.yarn.api.records.Token&nbsp;token)</pre>
<div class="block">Sets the NMToken for node address only in the singleton obtained from
<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--"><code>getSingleton()</code></a>. If you are using your own NMTokenCache that is
different from the singleton, use <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#setToken-java.lang.String-org.apache.hadoop.yarn.api.records.Token-"><code>setToken(String, Token)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeAddr</code> - node address (host:port)</dd>
<dd><code>token</code> - NMToken</dd>
</dl>
</li>
</ul>
<a name="getToken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getToken</h4>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public&nbsp;org.apache.hadoop.yarn.api.records.Token&nbsp;getToken(<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;nodeAddr)</pre>
<div class="block">Returns NMToken, null if absent</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeAddr</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Token</code> NMToken required for communicating with node
manager</dd>
</dl>
</li>
</ul>
<a name="setToken-java.lang.String-org.apache.hadoop.yarn.api.records.Token-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToken</h4>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public&nbsp;void&nbsp;setToken(<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;nodeAddr,
org.apache.hadoop.yarn.api.records.Token&nbsp;token)</pre>
<div class="block">Sets the NMToken for node address</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeAddr</code> - node address (host:port)</dd>
<dd><code>token</code> - NMToken</dd>
</dl>
</li>
</ul>
<a name="containsToken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsToken</h4>
<pre>@InterfaceAudience.Private
public&nbsp;boolean&nbsp;containsToken(<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;nodeAddr)</pre>
<div class="block">Returns true if NMToken is present in cache.</div>
</li>
</ul>
<a name="numberOfTokensInCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numberOfTokensInCache</h4>
<pre>@InterfaceAudience.Private
public&nbsp;int&nbsp;numberOfTokensInCache()</pre>
<div class="block">Returns the number of NMTokens present in cache.</div>
</li>
</ul>
<a name="removeToken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeToken</h4>
<pre>@InterfaceAudience.Private
public&nbsp;void&nbsp;removeToken(<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;nodeAddr)</pre>
<div class="block">Removes NMToken for specified node manager</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeAddr</code> - node address (host:port)</dd>
</dl>
</li>
</ul>
<a name="clearCache--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clearCache</h4>
<pre>@InterfaceAudience.Private
public&nbsp;void&nbsp;clearCache()</pre>
<div class="block">It will remove all the nm tokens from its cache</div>
</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/NMTokenCache.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/NMClient.UpgradeOp.html" title="enum in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/yarn/client/api/SharedCacheClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/client/api/NMTokenCache.html" target="_top">Frames</a></li>
<li><a href="NMTokenCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>