| <!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:10:58 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CollectorNodemanagerProtocol (Apache Hadoop YARN Server Common 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="CollectorNodemanagerProtocol (Apache Hadoop YARN Server Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":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/CollectorNodemanagerProtocol.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/api/CollectorNodemanagerProtocolPB.html" title="interface in org.apache.hadoop.yarn.server.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/api/CollectorNodemanagerProtocol.html" target="_top">Frames</a></li> |
| <li><a href="CollectorNodemanagerProtocol.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.server.api</div> |
| <h2 title="Interface CollectorNodemanagerProtocol" class="title">Interface CollectorNodemanagerProtocol</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/server/api/impl/pb/client/CollectorNodemanagerProtocolPBClientImpl.html" title="class in org.apache.hadoop.yarn.server.api.impl.pb.client">CollectorNodemanagerProtocolPBClientImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public interface <span class="typeNameLabel">CollectorNodemanagerProtocol</span></pre> |
| <div class="block"><p>The protocol between an <code>TimelineCollectorManager</code> and a |
| <code>NodeManager</code> to report a new application collector get launched. |
| </p></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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/GetTimelineCollectorContextResponse.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">GetTimelineCollectorContextResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/api/CollectorNodemanagerProtocol.html#getTimelineCollectorContext-org.apache.hadoop.yarn.server.api.protocolrecords.GetTimelineCollectorContextRequest-">getTimelineCollectorContext</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/GetTimelineCollectorContextRequest.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">GetTimelineCollectorContextRequest</a> request)</code> |
| <div class="block"> |
| The collector needs to get the context information including user, flow |
| and flow run ID to associate with every incoming put-entity requests.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoResponse.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">ReportNewCollectorInfoResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/api/CollectorNodemanagerProtocol.html#reportNewCollectorInfo-org.apache.hadoop.yarn.server.api.protocolrecords.ReportNewCollectorInfoRequest-">reportNewCollectorInfo</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoRequest.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">ReportNewCollectorInfoRequest</a> request)</code> |
| <div class="block"> |
| The <code>TimelineCollectorManager</code> provides a list of mapping |
| between application and collector's address in |
| <a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoRequest.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords"><code>ReportNewCollectorInfoRequest</code></a> to a <code>NodeManager</code> to |
| <em>register</em> collector's info, include: applicationId and REST URI to |
| access collector.</div> |
| </td> |
| </tr> |
| </table> |
| </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="reportNewCollectorInfo-org.apache.hadoop.yarn.server.api.protocolrecords.ReportNewCollectorInfoRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reportNewCollectorInfo</h4> |
| <pre><a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoResponse.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">ReportNewCollectorInfoResponse</a> reportNewCollectorInfo(<a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoRequest.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">ReportNewCollectorInfoRequest</a> request) |
| 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"><p> |
| The <code>TimelineCollectorManager</code> provides a list of mapping |
| between application and collector's address in |
| <a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoRequest.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords"><code>ReportNewCollectorInfoRequest</code></a> to a <code>NodeManager</code> to |
| <em>register</em> collector's info, include: applicationId and REST URI to |
| access collector. NodeManager will add them into registered collectors |
| and register them into <code>ResourceManager</code> afterwards. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the request of registering a new collector or a list of |
| collectors</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the response for registering the new collector</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the request is invalid</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> - if there are I/O errors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimelineCollectorContext-org.apache.hadoop.yarn.server.api.protocolrecords.GetTimelineCollectorContextRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTimelineCollectorContext</h4> |
| <pre><a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/GetTimelineCollectorContextResponse.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">GetTimelineCollectorContextResponse</a> getTimelineCollectorContext(<a href="../../../../../../org/apache/hadoop/yarn/server/api/protocolrecords/GetTimelineCollectorContextRequest.html" title="class in org.apache.hadoop.yarn.server.api.protocolrecords">GetTimelineCollectorContextRequest</a> request) |
| 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"><p> |
| The collector needs to get the context information including user, flow |
| and flow run ID to associate with every incoming put-entity requests. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the request of getting the aggregator context information of |
| the given application</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the response for registering the new collector</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the request is invalid</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> - if there are I/O errors</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/CollectorNodemanagerProtocol.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/api/CollectorNodemanagerProtocolPB.html" title="interface in org.apache.hadoop.yarn.server.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/api/CollectorNodemanagerProtocol.html" target="_top">Frames</a></li> |
| <li><a href="CollectorNodemanagerProtocol.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
