| <!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:45 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TimelineReader (Apache Hadoop YARN ApplicationHistoryService 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="TimelineReader (Apache Hadoop YARN ApplicationHistoryService 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TimelineReader.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/timeline/TimelineDataManagerMetrics.html" title="class in org.apache.hadoop.yarn.server.timeline"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/timeline/TimelineReader.html" target="_top">Frames</a></li> |
| <li><a href="TimelineReader.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.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.server.timeline</div> |
| <h2 title="Interface TimelineReader" class="title">Interface TimelineReader</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineStore.html" title="interface in org.apache.hadoop.yarn.server.timeline">TimelineStore</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/LeveldbTimelineStore.html" title="class in org.apache.hadoop.yarn.server.timeline">LeveldbTimelineStore</a>, <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/MemoryTimelineStore.html" title="class in org.apache.hadoop.yarn.server.timeline">MemoryTimelineStore</a>, <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/RollingLevelDBTimelineStore.html" title="class in org.apache.hadoop.yarn.server.timeline">RollingLevelDBTimelineStore</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public interface <span class="typeNameLabel">TimelineReader</span></pre> |
| <div class="block">This interface is for retrieving timeline information.</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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline">TimelineReader.Field</a></span></code> |
| <div class="block">Possible fields to retrieve for <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntities-java.lang.String-java.lang.Long-java.lang.Long-java.lang.Long-java.lang.String-java.lang.Long-org.apache.hadoop.yarn.server.timeline.NameValuePair-java.util.Collection-java.util.EnumSet-org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl-"><code>getEntities(java.lang.String, java.lang.Long, java.lang.Long, java.lang.Long, java.lang.String, java.lang.Long, org.apache.hadoop.yarn.server.timeline.NameValuePair, java.util.Collection<org.apache.hadoop.yarn.server.timeline.NameValuePair>, java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field>, org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl)</code></a> and <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntity-java.lang.String-java.lang.String-java.util.EnumSet-"><code>getEntity(java.lang.String, java.lang.String, java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field>)</code></a> |
| .</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#DEFAULT_LIMIT">DEFAULT_LIMIT</a></span></code> |
| <div class="block">Default limit for <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntities-java.lang.String-java.lang.Long-java.lang.Long-java.lang.Long-java.lang.String-java.lang.Long-org.apache.hadoop.yarn.server.timeline.NameValuePair-java.util.Collection-java.util.EnumSet-org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl-"><code>getEntities(java.lang.String, java.lang.Long, java.lang.Long, java.lang.Long, java.lang.String, java.lang.Long, org.apache.hadoop.yarn.server.timeline.NameValuePair, java.util.Collection<org.apache.hadoop.yarn.server.timeline.NameValuePair>, java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field>, org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl)</code></a> and <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntityTimelines-java.lang.String-java.util.SortedSet-java.lang.Long-java.lang.Long-java.lang.Long-java.util.Set-"><code>getEntityTimelines(java.lang.String, java.util.SortedSet<java.lang.String>, java.lang.Long, java.lang.Long, java.lang.Long, java.util.Set<java.lang.String>)</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timeline.TimelineDomain</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getDomain-java.lang.String-">getDomain</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> domainId)</code> |
| <div class="block">This method retrieves the domain information for a given ID.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timeline.TimelineDomains</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getDomains-java.lang.String-">getDomains</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> owner)</code> |
| <div class="block">This method retrieves all the domains that belong to a given owner.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timeline.TimelineEntities</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntities-java.lang.String-java.lang.Long-java.lang.Long-java.lang.Long-java.lang.String-java.lang.Long-org.apache.hadoop.yarn.server.timeline.NameValuePair-java.util.Collection-java.util.EnumSet-org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl-">getEntities</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> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> limit, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowStart, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowEnd, |
| <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> fromId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> fromTs, |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/NameValuePair.html" title="class in org.apache.hadoop.yarn.server.timeline">NameValuePair</a> primaryFilter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/hadoop/yarn/server/timeline/NameValuePair.html" title="class in org.apache.hadoop.yarn.server.timeline">NameValuePair</a>> secondaryFilters, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline">TimelineReader.Field</a>> fieldsToRetrieve, |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineDataManager.CheckAcl.html" title="interface in org.apache.hadoop.yarn.server.timeline">TimelineDataManager.CheckAcl</a> checkAcl)</code> |
| <div class="block">This method retrieves a list of entity information, <code>TimelineEntity</code>, |
| sorted by the starting timestamp for the entity, descending.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timeline.TimelineEntity</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntity-java.lang.String-java.lang.String-java.util.EnumSet-">getEntity</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> entityId, |
| <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> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline">TimelineReader.Field</a>> fieldsToRetrieve)</code> |
| <div class="block">This method retrieves the entity information for a given entity.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timeline.TimelineEvents</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntityTimelines-java.lang.String-java.util.SortedSet-java.lang.Long-java.lang.Long-java.lang.Long-java.util.Set-">getEntityTimelines</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> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</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>> entityIds, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> limit, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowStart, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowEnd, |
| <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>> eventTypes)</code> |
| <div class="block">This method retrieves the events for a list of entities all of the same |
| entity type.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_LIMIT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_LIMIT</h4> |
| <pre>static final long DEFAULT_LIMIT</pre> |
| <div class="block">Default limit for <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntities-java.lang.String-java.lang.Long-java.lang.Long-java.lang.Long-java.lang.String-java.lang.Long-org.apache.hadoop.yarn.server.timeline.NameValuePair-java.util.Collection-java.util.EnumSet-org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl-"><code>getEntities(java.lang.String, java.lang.Long, java.lang.Long, java.lang.Long, java.lang.String, java.lang.Long, org.apache.hadoop.yarn.server.timeline.NameValuePair, java.util.Collection<org.apache.hadoop.yarn.server.timeline.NameValuePair>, java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field>, org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl)</code></a> and <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#getEntityTimelines-java.lang.String-java.util.SortedSet-java.lang.Long-java.lang.Long-java.lang.Long-java.util.Set-"><code>getEntityTimelines(java.lang.String, java.util.SortedSet<java.lang.String>, java.lang.Long, java.lang.Long, java.lang.Long, java.util.Set<java.lang.String>)</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timeline.TimelineReader.DEFAULT_LIMIT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEntities-java.lang.String-java.lang.Long-java.lang.Long-java.lang.Long-java.lang.String-java.lang.Long-org.apache.hadoop.yarn.server.timeline.NameValuePair-java.util.Collection-java.util.EnumSet-org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntities</h4> |
| <pre>org.apache.hadoop.yarn.api.records.timeline.TimelineEntities getEntities(<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> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> limit, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowStart, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowEnd, |
| <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> fromId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> fromTs, |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/NameValuePair.html" title="class in org.apache.hadoop.yarn.server.timeline">NameValuePair</a> primaryFilter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/hadoop/yarn/server/timeline/NameValuePair.html" title="class in org.apache.hadoop.yarn.server.timeline">NameValuePair</a>> secondaryFilters, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline">TimelineReader.Field</a>> fieldsToRetrieve, |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineDataManager.CheckAcl.html" title="interface in org.apache.hadoop.yarn.server.timeline">TimelineDataManager.CheckAcl</a> checkAcl) |
| 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">This method retrieves a list of entity information, <code>TimelineEntity</code>, |
| sorted by the starting timestamp for the entity, descending. The starting |
| timestamp of an entity is a timestamp specified by the client. If it is not |
| explicitly specified, it will be chosen by the store to be the earliest |
| timestamp of the events received in the first put for the entity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entityType</code> - The type of entities to return (required).</dd> |
| <dd><code>limit</code> - A limit on the number of entities to return. If null, defaults to |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#DEFAULT_LIMIT"><code>DEFAULT_LIMIT</code></a>.</dd> |
| <dd><code>windowStart</code> - The earliest start timestamp to retrieve (exclusive). If null, |
| defaults to retrieving all entities until the limit is reached.</dd> |
| <dd><code>windowEnd</code> - The latest start timestamp to retrieve (inclusive). If null, |
| defaults to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a></dd> |
| <dd><code>fromId</code> - If fromId is not null, retrieve entities earlier than and |
| including the specified ID. If no start time is found for the |
| specified ID, an empty list of entities will be returned. The |
| windowEnd parameter will take precedence if the start time of this |
| entity falls later than windowEnd.</dd> |
| <dd><code>fromTs</code> - If fromTs is not null, ignore entities that were inserted into the |
| store after the given timestamp. The entity's insert timestamp |
| used for this comparison is the store's system time when the first |
| put for the entity was received (not the entity's start time).</dd> |
| <dd><code>primaryFilter</code> - Retrieves only entities that have the specified primary filter. If |
| null, retrieves all entities. This is an indexed retrieval, and no |
| entities that do not match the filter are scanned.</dd> |
| <dd><code>secondaryFilters</code> - Retrieves only entities that have exact matches for all the |
| specified filters in their primary filters or other info. This is |
| not an indexed retrieval, so all entities are scanned but only |
| those matching the filters are returned.</dd> |
| <dd><code>fieldsToRetrieve</code> - Specifies which fields of the entity object to retrieve (see |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline"><code>TimelineReader.Field</code></a>). If the set of fields contains |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html#LAST_EVENT_ONLY"><code>TimelineReader.Field.LAST_EVENT_ONLY</code></a> and not <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html#EVENTS"><code>TimelineReader.Field.EVENTS</code></a>, the |
| most recent event for each entity is retrieved. If null, retrieves |
| all fields.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An <code>TimelineEntities</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntity-java.lang.String-java.lang.String-java.util.EnumSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntity</h4> |
| <pre>org.apache.hadoop.yarn.api.records.timeline.TimelineEntity getEntity(<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> entityId, |
| <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> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline">TimelineReader.Field</a>> fieldsToRetrieve) |
| 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">This method retrieves the entity information for a given entity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entityId</code> - The entity whose information will be retrieved.</dd> |
| <dd><code>entityType</code> - The type of the entity.</dd> |
| <dd><code>fieldsToRetrieve</code> - Specifies which fields of the entity object to retrieve (see |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline"><code>TimelineReader.Field</code></a>). If the set of fields contains |
| <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html#LAST_EVENT_ONLY"><code>TimelineReader.Field.LAST_EVENT_ONLY</code></a> and not <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html#EVENTS"><code>TimelineReader.Field.EVENTS</code></a>, the |
| most recent event for each entity is retrieved. If null, retrieves |
| all fields.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An <code>TimelineEntity</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntityTimelines-java.lang.String-java.util.SortedSet-java.lang.Long-java.lang.Long-java.lang.Long-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityTimelines</h4> |
| <pre>org.apache.hadoop.yarn.api.records.timeline.TimelineEvents getEntityTimelines(<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> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</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>> entityIds, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> limit, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowStart, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> windowEnd, |
| <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>> eventTypes) |
| 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">This method retrieves the events for a list of entities all of the same |
| entity type. The events for each entity are sorted in order of their |
| timestamps, descending.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entityType</code> - The type of entities to retrieve events for.</dd> |
| <dd><code>entityIds</code> - The entity IDs to retrieve events for.</dd> |
| <dd><code>limit</code> - A limit on the number of events to return for each entity. If |
| null, defaults to <a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.html#DEFAULT_LIMIT"><code>DEFAULT_LIMIT</code></a> events per entity.</dd> |
| <dd><code>windowStart</code> - If not null, retrieves only events later than the given time |
| (exclusive)</dd> |
| <dd><code>windowEnd</code> - If not null, retrieves only events earlier than the given time |
| (inclusive)</dd> |
| <dd><code>eventTypes</code> - Restricts the events returned to the given types. If null, events |
| of all types will be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An <code>TimelineEvents</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDomain-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDomain</h4> |
| <pre>org.apache.hadoop.yarn.api.records.timeline.TimelineDomain getDomain(<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> domainId) |
| 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">This method retrieves the domain information for a given ID.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDomains-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDomains</h4> |
| <pre>org.apache.hadoop.yarn.api.records.timeline.TimelineDomains getDomains(<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> owner) |
| 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">This method retrieves all the domains that belong to a given owner. |
| The domains are sorted according to the created time firstly and the |
| modified time secondly in descending order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>owner</code> - the domain owner</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>TimelineDomains</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> |
| </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/TimelineReader.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/timeline/TimelineDataManagerMetrics.html" title="class in org.apache.hadoop.yarn.server.timeline"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/timeline/TimelineReader.Field.html" title="enum in org.apache.hadoop.yarn.server.timeline"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/timeline/TimelineReader.html" target="_top">Frames</a></li> |
| <li><a href="TimelineReader.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.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
