| <!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:11:52 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TimelineReaderManager (Apache Hadoop YARN Timeline Service 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="TimelineReaderManager (Apache Hadoop YARN Timeline Service 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/TimelineReaderManager.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/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderServer.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html" target="_top">Frames</a></li> |
| <li><a href="TimelineReaderManager.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><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.server.timelineservice.reader</div> |
| <h2 title="Class TimelineReaderManager" class="title">Class TimelineReaderManager</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.yarn.server.timelineservice.reader.TimelineReaderManager</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, org.apache.hadoop.service.Service</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">TimelineReaderManager</span> |
| extends org.apache.hadoop.service.AbstractService</pre> |
| <div class="block">This class wraps over the timeline reader store implementation. It does some |
| non trivial manipulation of the timeline data before or after getting |
| it from the backend store.</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.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> |
| <!-- ======== 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/server/timelineservice/reader/TimelineReaderManager.html#TimelineReaderManager-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader-">TimelineReaderManager</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader</a> timelineReader)</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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html#checkAccess-org.apache.hadoop.security.UserGroupInformation-">checkAccess</a></span>(org.apache.hadoop.security.UserGroupInformation callerUGI)</code> |
| <div class="block">The API to confirm is a User is allowed to read this data.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html#getEntities-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-">getEntities</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineReaderContext</a> context, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineEntityFilters.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineEntityFilters</a> filters, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineDataToRetrieve</a> dataToRetrieve)</code> |
| <div class="block">Get a set of entities matching given predicates by making a call to |
| backend storage implementation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html#getEntity-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-">getEntity</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineReaderContext</a> context, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineDataToRetrieve</a> dataToRetrieve)</code> |
| <div class="block">Get single timeline entity by making a call to backend storage |
| implementation.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html#getEntityTypes-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-">getEntityTypes</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineReaderContext</a> context)</code> |
| <div class="block">Gets a list of available timeline entity types for an application.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timeline.TimelineHealth</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html#getHealthStatus--">getHealthStatus</a></span>()</code> |
| <div class="block">Check if reader connection is alive.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html#serviceInit-org.apache.hadoop.conf.Configuration-">serviceInit</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| </table> |
| <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, serviceStart, serviceStop, 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="TimelineReaderManager-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TimelineReaderManager</h4> |
| <pre>public TimelineReaderManager(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineReader</a> timelineReader)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <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.AbstractService</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntities-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntities</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getEntities(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineReaderContext</a> context, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineEntityFilters.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineEntityFilters</a> filters, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineDataToRetrieve</a> dataToRetrieve) |
| 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></pre> |
| <div class="block">Get a set of entities matching given predicates by making a call to |
| backend storage implementation. The meaning of each argument has been |
| documented in detail with <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html#getEntities-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"><code>TimelineReader.getEntities(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)</code></a>.If cluster ID |
| has not been supplied by the client, fills the cluster id from config |
| before making a call to backend storage. After fetching entities from |
| backend, fills the appropriate UID based on entity type for each entity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Timeline context within the scope of which entities have to |
| be fetched.</dd> |
| <dd><code>filters</code> - Filters which limit the number of entities to be returned.</dd> |
| <dd><code>dataToRetrieve</code> - Data to carry in each entity fetched.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of <cite>TimelineEntity</cite> objects.</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 any problem occurs while getting entities.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html#getEntities-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"><code>TimelineReader.getEntities(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntity-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntity</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getEntity(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineReaderContext</a> context, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineDataToRetrieve.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineDataToRetrieve</a> dataToRetrieve) |
| 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></pre> |
| <div class="block">Get single timeline entity by making a call to backend storage |
| implementation. The meaning of each argument in detail has been |
| documented with <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html#getEntity-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"><code>TimelineReader.getEntity(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)</code></a>. If cluster ID has not |
| been supplied by the client, fills the cluster id from config before making |
| a call to backend storage. After fetching entity from backend, fills the |
| appropriate UID based on entity type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Timeline context within the scope of which entity has to be |
| fetched.</dd> |
| <dd><code>dataToRetrieve</code> - Data to carry in the entity fetched.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <cite>TimelineEntity</cite> object if found, null otherwise.</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 any problem occurs while getting entity.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html#getEntity-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"><code>TimelineReader.getEntity(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntityTypes-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityTypes</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>> getEntityTypes(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader">TimelineReaderContext</a> context) |
| 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></pre> |
| <div class="block">Gets a list of available timeline entity types for an application. This can |
| be done by making a call to the backend storage implementation. The meaning |
| of each argument in detail is the same as <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineReader.html#getEntity-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"><code>TimelineReader.getEntity(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext, org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve)</code></a>. |
| If cluster ID has not been supplied by the client, fills the cluster id |
| from config before making a call to backend storage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Timeline context within the scope of which entity types |
| have to be fetched. Entity type field of this context should |
| be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A set which contains available timeline entity types, represented |
| as strings if found, empty otherwise.</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 any problem occurs while getting entity types.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAccess-org.apache.hadoop.security.UserGroupInformation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAccess</h4> |
| <pre>public boolean checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI)</pre> |
| <div class="block">The API to confirm is a User is allowed to read this data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callerUGI</code> - UserGroupInformation of the user</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHealthStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHealthStatus</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.timeline.TimelineHealth getHealthStatus()</pre> |
| <div class="block">Check if reader connection is alive.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean True if reader connection is alive, false otherwise.</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/TimelineReaderManager.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/server/timelineservice/reader/TimelineReaderContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderServer.html" title="class in org.apache.hadoop.yarn.server.timelineservice.reader"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/reader/TimelineReaderManager.html" target="_top">Frames</a></li> |
| <li><a href="TimelineReaderManager.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><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> |