| <!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>TimelineClient (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="TimelineClient (Apache Hadoop YARN Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":9,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TimelineClient.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/AppAdminClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineReaderClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/client/api/TimelineClient.html" target="_top">Frames</a></li> |
| <li><a href="TimelineClient.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</div> |
| <h2 title="Class TimelineClient" class="title">Class TimelineClient</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>org.apache.hadoop.yarn.client.api.TimelineClient</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/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/client/api/impl/TimelineClientImpl.html" title="class in org.apache.hadoop.yarn.client.api.impl">TimelineClientImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public abstract class <span class="typeNameLabel">TimelineClient</span> |
| extends org.apache.hadoop.service.CompositeService |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></pre> |
| <div class="block">A client library that can be used to post some information in terms of a |
| number of conceptual entities. This client library needs to be used along |
| with Timeline V.1.x server versions. |
| Refer <a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineV2Client.html" title="class in org.apache.hadoop.yarn.client.api"><code>TimelineV2Client</code></a> for ATS V2 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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#TimelineClient-java.lang.String-">TimelineClient</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> name)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#cancelDelegationToken-org.apache.hadoop.security.token.Token-">cancelDelegationToken</a></span>(org.apache.hadoop.security.token.Token<<a href="../../../../../../org/apache/hadoop/yarn/security/client/TimelineDelegationTokenIdentifier.html" title="class in org.apache.hadoop.yarn.security.client">TimelineDelegationTokenIdentifier</a>> timelineDT)</code> |
| <div class="block"> |
| Cancel a timeline delegation token.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html" title="class in org.apache.hadoop.yarn.client.api">TimelineClient</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#createTimelineClient--">createTimelineClient</a></span>()</code> |
| <div class="block">Creates an instance of the timeline v.1.x client.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract org.apache.hadoop.security.token.Token<<a href="../../../../../../org/apache/hadoop/yarn/security/client/TimelineDelegationTokenIdentifier.html" title="class in org.apache.hadoop.yarn.security.client">TimelineDelegationTokenIdentifier</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#getDelegationToken-java.lang.String-">getDelegationToken</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> renewer)</code> |
| <div class="block"> |
| Get a delegation token so as to be able to talk to the timeline server in a |
| secure way.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#putDomain-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-org.apache.hadoop.yarn.api.records.timeline.TimelineDomain-">putDomain</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, |
| org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain)</code> |
| <div class="block"> |
| Send the information of a domain to the timeline server.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#putDomain-org.apache.hadoop.yarn.api.records.timeline.TimelineDomain-">putDomain</a></span>(org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain)</code> |
| <div class="block"> |
| Send the information of a domain to the timeline server.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#putEntities-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId-org.apache.hadoop.yarn.api.records.timeline.TimelineEntity...-">putEntities</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, |
| org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId groupId, |
| org.apache.hadoop.yarn.api.records.timeline.TimelineEntity... entities)</code> |
| <div class="block"> |
| Send the information of a number of conceptual entities to the timeline |
| server.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#putEntities-org.apache.hadoop.yarn.api.records.timeline.TimelineEntity...-">putEntities</a></span>(org.apache.hadoop.yarn.api.records.timeline.TimelineEntity... entities)</code> |
| <div class="block"> |
| Send the information of a number of conceptual entities to the timeline |
| server.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html#renewDelegationToken-org.apache.hadoop.security.token.Token-">renewDelegationToken</a></span>(org.apache.hadoop.security.token.Token<<a href="../../../../../../org/apache/hadoop/yarn/security/client/TimelineDelegationTokenIdentifier.html" title="class in org.apache.hadoop.yarn.security.client">TimelineDelegationTokenIdentifier</a>> timelineDT)</code> |
| <div class="block"> |
| Renew a timeline delegation token.</div> |
| </td> |
| </tr> |
| </table> |
| <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, serviceInit, serviceStart, serviceStop</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.io.Flushable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.io.<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Flushable.html?is-external=true#flush--" title="class or interface in java.io">flush</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="TimelineClient-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TimelineClient</h4> |
| <pre>protected TimelineClient(<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> 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="createTimelineClient--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimelineClient</h4> |
| <pre>@InterfaceAudience.Public |
| public static <a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineClient.html" title="class in org.apache.hadoop.yarn.client.api">TimelineClient</a> createTimelineClient()</pre> |
| <div class="block">Creates an instance of the timeline v.1.x client. |
| The current UGI when the user initialize the client will be used to do the |
| put and the delegation token operations. The current user may use |
| <code>UserGroupInformation.doAs(java.security.PrivilegedAction<T>)</code> another user to construct and initialize |
| a timeline client if the following operations are supposed to be conducted |
| by that user.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the created timeline client instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putEntities-org.apache.hadoop.yarn.api.records.timeline.TimelineEntity...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putEntities</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse putEntities(org.apache.hadoop.yarn.api.records.timeline.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"><p> |
| Send the information of a number of conceptual entities to the timeline |
| server. It is a blocking API. The method will not return until it gets the |
| response from the timeline server. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entities</code> - the collection of <code>TimelineEntity</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the error information if the sent entities are not correctly stored</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="putEntities-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId-org.apache.hadoop.yarn.api.records.timeline.TimelineEntity...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putEntities</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse putEntities(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, |
| org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId groupId, |
| org.apache.hadoop.yarn.api.records.timeline.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"><p> |
| Send the information of a number of conceptual entities to the timeline |
| server. It is a blocking API. The method will not return until it gets the |
| response from the timeline server. |
| |
| This API is only for timeline service v1.5 |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appAttemptId</code> - <code>ApplicationAttemptId</code></dd> |
| <dd><code>groupId</code> - <code>TimelineEntityGroupId</code></dd> |
| <dd><code>entities</code> - the collection of <code>TimelineEntity</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the error information if the sent entities are not correctly stored</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="putDomain-org.apache.hadoop.yarn.api.records.timeline.TimelineDomain-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putDomain</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract void putDomain(org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain) |
| 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"><p> |
| Send the information of a domain to the timeline server. It is a |
| blocking API. The method will not return until it gets the response from |
| the timeline server. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>domain</code> - an <code>TimelineDomain</code> object</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></dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putDomain-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-org.apache.hadoop.yarn.api.records.timeline.TimelineDomain-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putDomain</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract void putDomain(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, |
| org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain) |
| 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"><p> |
| Send the information of a domain to the timeline server. It is a |
| blocking API. The method will not return until it gets the response from |
| the timeline server. |
| |
| This API is only for timeline service v1.5 |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>domain</code> - an <code>TimelineDomain</code> object</dd> |
| <dd><code>appAttemptId</code> - <code>ApplicationAttemptId</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></dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDelegationToken-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelegationToken</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract org.apache.hadoop.security.token.Token<<a href="../../../../../../org/apache/hadoop/yarn/security/client/TimelineDelegationTokenIdentifier.html" title="class in org.apache.hadoop.yarn.security.client">TimelineDelegationTokenIdentifier</a>> getDelegationToken(<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> renewer) |
| 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"><p> |
| Get a delegation token so as to be able to talk to the timeline server in a |
| secure way. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>renewer</code> - Address of the renewer who can renew these tokens when needed by |
| securely talking to the timeline server</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a delegation token (<code>Token</code>) that can be used to talk to the |
| timeline server</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></dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renewDelegationToken-org.apache.hadoop.security.token.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewDelegationToken</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract long renewDelegationToken(org.apache.hadoop.security.token.Token<<a href="../../../../../../org/apache/hadoop/yarn/security/client/TimelineDelegationTokenIdentifier.html" title="class in org.apache.hadoop.yarn.security.client">TimelineDelegationTokenIdentifier</a>> timelineDT) |
| 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"><p> |
| Renew a timeline delegation token. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timelineDT</code> - the delegation token to renew</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new expiration time</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></dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelDelegationToken-org.apache.hadoop.security.token.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cancelDelegationToken</h4> |
| <pre>@InterfaceAudience.Public |
| public abstract void cancelDelegationToken(org.apache.hadoop.security.token.Token<<a href="../../../../../../org/apache/hadoop/yarn/security/client/TimelineDelegationTokenIdentifier.html" title="class in org.apache.hadoop.yarn.security.client">TimelineDelegationTokenIdentifier</a>> timelineDT) |
| 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"><p> |
| Cancel a timeline delegation token. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timelineDT</code> - the delegation token to cancel</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></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/TimelineClient.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/AppAdminClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/client/api/TimelineReaderClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/client/api/TimelineClient.html" target="_top">Frames</a></li> |
| <li><a href="TimelineClient.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> |
