| <!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:04 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TimelineV2ClientImpl (Apache Hadoop YARN 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="TimelineV2ClientImpl (Apache Hadoop YARN Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All 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/TimelineV2ClientImpl.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/TimelineReaderClientImpl.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/TimelineWriter.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/client/api/impl/TimelineV2ClientImpl.html" target="_top">Frames</a></li> |
| <li><a href="TimelineV2ClientImpl.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.service.CompositeService">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.hadoop.service.CompositeService">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 TimelineV2ClientImpl" class="title">Class TimelineV2ClientImpl</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>org.apache.hadoop.service.CompositeService</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">org.apache.hadoop.yarn.client.api.TimelineV2Client</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.client.api.impl.TimelineV2ClientImpl</li> |
| </ul> |
| </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>public class <span class="typeNameLabel">TimelineV2ClientImpl</span> |
| extends <a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></pre> |
| <div class="block">Implementation of timeline v2 client interface.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.service.CompositeService"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService</h3> |
| <code>org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook</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 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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.service.CompositeService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.hadoop.service.CompositeService</h3> |
| <code>STOP_ONLY_STARTED_SERVICES</code></li> |
| </ul> |
| </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"> </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/TimelineV2ClientImpl.html#TimelineV2ClientImpl-org.apache.hadoop.yarn.api.records.ApplicationId-">TimelineV2ClientImpl</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>org.apache.hadoop.yarn.api.records.ApplicationId</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/TimelineV2ClientImpl.html#getContextAppId--">getContextAppId</a></span>()</code> </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/TimelineV2ClientImpl.html#putEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putEntities</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities)</code> |
| <div class="block"> |
| Send the information of a number of conceptual entities within the scope |
| of YARN application to the timeline service v.2 collector.</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/TimelineV2ClientImpl.html#putEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putEntitiesAsync</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities)</code> |
| <div class="block"> |
| Send the information of a number of conceptual entities within the scope |
| of YARN application to the timeline service v.2 collector.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/TimelineV2ClientImpl.html#putObjects-java.lang.String-javax.ws.rs.core.MultivaluedMap-java.lang.Object-">putObjects</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> path, |
| javax.ws.rs.core.MultivaluedMap<<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/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> params, |
| <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> obj)</code> </td> |
| </tr> |
| <tr id="i4" 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/TimelineV2ClientImpl.html#putObjects-java.net.URI-java.lang.String-javax.ws.rs.core.MultivaluedMap-java.lang.Object-">putObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> base, |
| <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> path, |
| javax.ws.rs.core.MultivaluedMap<<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/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> params, |
| <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> obj)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/TimelineV2ClientImpl.html#putSubAppEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putSubAppEntities</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities)</code> |
| <div class="block"> |
| Send the information of a number of conceptual entities within the scope of |
| a sub-application to the timeline service v.2 collector.</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/impl/TimelineV2ClientImpl.html#putSubAppEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putSubAppEntitiesAsync</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities)</code> |
| <div class="block"> |
| Send the information of a number of conceptual entities within the scope of |
| a sub-application to the timeline service v.2 collector.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/TimelineV2ClientImpl.html#serviceInit-org.apache.hadoop.conf.Configuration-">serviceInit</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i8" 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/TimelineV2ClientImpl.html#serviceStart--">serviceStart</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" 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/TimelineV2ClientImpl.html#serviceStop--">serviceStop</a></span>()</code> </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/TimelineV2ClientImpl.html#setTimelineCollectorInfo-org.apache.hadoop.yarn.api.records.CollectorInfo-">setTimelineCollectorInfo</a></span>(org.apache.hadoop.yarn.api.records.CollectorInfo collectorInfo)</code> |
| <div class="block"> |
| Update collector info received in AllocateResponse which contains the |
| timeline service address where the request will be sent to and the timeline |
| delegation token which will be used to send the request.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.client.api.TimelineV2Client"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.yarn.client.api.<a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></h3> |
| <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#createTimelineClient-org.apache.hadoop.yarn.api.records.ApplicationId-">createTimelineClient</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.service.CompositeService"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.service.CompositeService</h3> |
| <code>addIfService, addService, getServices, removeService</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 org.apache.hadoop.service.AbstractService</h3> |
| <code>close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, 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 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TimelineV2ClientImpl-org.apache.hadoop.yarn.api.records.ApplicationId-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TimelineV2ClientImpl</h4> |
| <pre>public TimelineV2ClientImpl(org.apache.hadoop.yarn.api.records.ApplicationId appId)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getContextAppId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContextAppId</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.ApplicationId getContextAppId()</pre> |
| </li> |
| </ul> |
| <a name="serviceInit-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceInit</h4> |
| <pre>protected void serviceInit(org.apache.hadoop.conf.Configuration 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> in class <code>org.apache.hadoop.service.CompositeService</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="serviceStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceStart</h4> |
| <pre>protected void serviceStart() |
| 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>serviceStart</code> in class <code>org.apache.hadoop.service.CompositeService</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="serviceStop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceStop</h4> |
| <pre>protected void 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> in class <code>org.apache.hadoop.service.CompositeService</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="putEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putEntities</h4> |
| <pre>public void putEntities(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities) |
| throws <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>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">TimelineV2Client</a></code></span></div> |
| <div class="block"><p> |
| Send the information of a number of conceptual entities within the scope |
| of YARN application to the timeline service v.2 collector. It is a blocking |
| API. The method will not return until all the put entities have been |
| persisted. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putEntities</a></code> in class <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entities</code> - the collection of <code>TimelineEntity</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if entities are incomplete/invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putEntitiesAsync</h4> |
| <pre>public void putEntitiesAsync(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities) |
| throws <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>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">TimelineV2Client</a></code></span></div> |
| <div class="block"><p> |
| Send the information of a number of conceptual entities within the scope |
| of YARN application to the timeline service v.2 collector. It is an |
| asynchronous API. The method will return once all the entities are |
| received. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putEntitiesAsync</a></code> in class <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entities</code> - the collection of <code>TimelineEntity</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if entities are incomplete/invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putSubAppEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putSubAppEntities</h4> |
| <pre>public void putSubAppEntities(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities) |
| throws <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>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putSubAppEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">TimelineV2Client</a></code></span></div> |
| <div class="block"><p> |
| Send the information of a number of conceptual entities within the scope of |
| a sub-application to the timeline service v.2 collector. It is a blocking |
| API. The method will not return until all the put entities have been |
| persisted. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putSubAppEntities-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putSubAppEntities</a></code> in class <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entities</code> - the collection of <code>TimelineEntity</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if entities are incomplete/invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putSubAppEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putSubAppEntitiesAsync</h4> |
| <pre>public void putSubAppEntitiesAsync(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity... entities) |
| throws <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>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putSubAppEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">TimelineV2Client</a></code></span></div> |
| <div class="block"><p> |
| Send the information of a number of conceptual entities within the scope of |
| a sub-application to the timeline service v.2 collector. It is an |
| asynchronous API. The method will return once all the entities are received |
| . |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#putSubAppEntitiesAsync-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity...-">putSubAppEntitiesAsync</a></code> in class <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entities</code> - the collection of <code>TimelineEntity</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if entities are incomplete/invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTimelineCollectorInfo-org.apache.hadoop.yarn.api.records.CollectorInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimelineCollectorInfo</h4> |
| <pre>public void setTimelineCollectorInfo(org.apache.hadoop.yarn.api.records.CollectorInfo collectorInfo)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#setTimelineCollectorInfo-org.apache.hadoop.yarn.api.records.CollectorInfo-">TimelineV2Client</a></code></span></div> |
| <div class="block"><p> |
| Update collector info received in AllocateResponse which contains the |
| timeline service address where the request will be sent to and the timeline |
| delegation token which will be used to send the request. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html#setTimelineCollectorInfo-org.apache.hadoop.yarn.api.records.CollectorInfo-">setTimelineCollectorInfo</a></code> in class <code><a href="../../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api">TimelineV2Client</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collectorInfo</code> - Collector info which contains the timeline service |
| address and timeline delegation token.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putObjects-java.lang.String-javax.ws.rs.core.MultivaluedMap-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putObjects</h4> |
| <pre>@InterfaceAudience.Private |
| protected void putObjects(<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> path, |
| javax.ws.rs.core.MultivaluedMap<<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/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> params, |
| <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> obj) |
| throws <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>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putObjects-java.net.URI-java.lang.String-javax.ws.rs.core.MultivaluedMap-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>putObjects</h4> |
| <pre>protected void putObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> base, |
| <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> path, |
| javax.ws.rs.core.MultivaluedMap<<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/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> params, |
| <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> obj) |
| throws <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>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></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/TimelineV2ClientImpl.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/TimelineReaderClientImpl.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/client/api/impl/TimelineWriter.html" title="class in org.apache.hadoop.yarn.client.api.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/client/api/impl/TimelineV2ClientImpl.html" target="_top">Frames</a></li> |
| <li><a href="TimelineV2ClientImpl.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.service.CompositeService">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.hadoop.service.CompositeService">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
