| <!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:13:06 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TimelineEntityReader (Apache Hadoop YARN TimelineService HBase Client 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="TimelineEntityReader (Apache Hadoop YARN TimelineService HBase Client 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":6,"i8":6,"i9":10,"i10":10,"i11":10,"i12":6,"i13":10,"i14":10,"i15":9,"i16":10,"i17":10,"i18":10}; |
| 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/TimelineEntityReader.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/storage/reader/EntityTypeReader.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReaderFactory.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html" target="_top">Frames</a></li> |
| <li><a href="TimelineEntityReader.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.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader">Nested</a> | </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.storage.reader</div> |
| <h2 title="Class TimelineEntityReader" class="title">Class TimelineEntityReader</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><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader">org.apache.hadoop.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.timelineservice.storage.reader.TimelineEntityReader</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">TimelineEntityReader</span> |
| extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader">AbstractTimelineStorageReader</a></pre> |
| <div class="block">The base class for reading and deserializing timeline entities from the |
| HBase storage. Different types can be defined for different types of the |
| entities that are being requested.</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.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.timelineservice.storage.reader.<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader">AbstractTimelineStorageReader</a></h3> |
| <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.FlowContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader">AbstractTimelineStorageReader.FlowContext</a></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/server/timelineservice/storage/reader/TimelineEntityReader.html#TimelineEntityReader-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-">TimelineEntityReader</a></span>(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext ctxt, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve toRetrieve)</code> |
| <div class="block">Instantiates a reader for single-entity reads.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#TimelineEntityReader-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-">TimelineEntityReader</a></span>(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext ctxt, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters entityFilters, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve toRetrieve)</code> |
| <div class="block">Instantiates a reader for multiple-entity reads.</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="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>protected abstract org.apache.hadoop.hbase.filter.FilterList</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#constructFilterListBasedOnFields-java.util.Set-">constructFilterListBasedOnFields</a></span>(<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>> cfsInFields)</code> |
| <div class="block">Creates a <code>FilterList</code> based on fields, confs and metrics to |
| retrieve.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected abstract org.apache.hadoop.hbase.filter.FilterList</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#constructFilterListBasedOnFilters--">constructFilterListBasedOnFilters</a></span>()</code> |
| <div class="block">Creates a <code>FilterList</code> based on info, config and metric filters.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>><br>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#createColQualifierPrefix-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-java.lang.String-">createColQualifierPrefix</a></span>(org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> colPrefix, |
| <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> column)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>><br>org.apache.hadoop.hbase.filter.FilterList</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#createFiltersFromColumnQualifiers-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-java.util.Set-">createFiltersFromColumnQualifiers</a></span>(org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> colPrefix, |
| <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>> columns)</code> |
| <div class="block">Create a filter list of qualifier filters based on passed set of columns.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#createFiltersIfNull--">createFiltersIfNull</a></span>()</code> |
| <div class="block">Create a <code>TimelineEntityFilters</code> object with default values for |
| filters.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#getDataToRetrieve--">getDataToRetrieve</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#getFilters--">getFilters</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected abstract org.apache.hadoop.hbase.client.Result</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#getResult-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-org.apache.hadoop.hbase.filter.FilterList-">getResult</a></span>(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn, |
| org.apache.hadoop.hbase.filter.FilterList filterList)</code> |
| <div class="block">Fetches a <code>Result</code> instance for a single-entity read.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected abstract org.apache.hadoop.hbase.client.ResultScanner</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#getResults-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-org.apache.hadoop.hbase.filter.FilterList-">getResults</a></span>(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn, |
| org.apache.hadoop.hbase.filter.FilterList filterList)</code> |
| <div class="block">Fetches a <code>ResultScanner</code> for a multi-entity read.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTableRW.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTableRW</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#getTable--">getTable</a></span>()</code> |
| <div class="block">Returns the main table to be used by the entity reader.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#hasField-java.util.EnumSet-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader.Field-">hasField</a></span>(<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><org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader.Field> fieldsToRetrieve, |
| org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader.Field requiredField)</code> |
| <div class="block">Check if we have a certain field amongst fields to retrieve.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#isSingleEntityRead--">isSingleEntityRead</a></span>()</code> |
| <div class="block">Checks whether the reader has been created to fetch single entity or |
| multiple entities.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected abstract 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/storage/reader/TimelineEntityReader.html#parseEntity-org.apache.hadoop.hbase.client.Result-">parseEntity</a></span>(org.apache.hadoop.hbase.client.Result result)</code> |
| <div class="block">Parses the result retrieved from HBase backend and convert it into a |
| <code>TimelineEntity</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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/storage/reader/TimelineEntityReader.html#readEntities-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-">readEntities</a></span>(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn)</code> |
| <div class="block">Reads and deserializes a set of timeline entities from the HBase storage.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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/storage/reader/TimelineEntityReader.html#readEntity-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-">readEntity</a></span>(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn)</code> |
| <div class="block">Reads and deserializes a single timeline entity from the HBase storage.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected static <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#readEvents-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.hbase.client.Result-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-">readEvents</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity entity, |
| org.apache.hadoop.hbase.client.Result result, |
| org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> prefix)</code> |
| <div class="block">Read events from the entity table or the application table.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#readMetrics-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.hbase.client.Result-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-">readMetrics</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity entity, |
| org.apache.hadoop.hbase.client.Result result, |
| org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<?> columnPrefix)</code> |
| <div class="block">Helper method for reading and deserializing <code>TimelineMetric</code> objects |
| using the specified column prefix.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#readRelationship-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.hbase.client.Result-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-boolean-">readRelationship</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity entity, |
| org.apache.hadoop.hbase.client.Result result, |
| org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> prefix, |
| boolean isRelatedTo)</code> |
| <div class="block">Helper method for reading relationship.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html#setTable-org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTableRW-">setTable</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTableRW.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTableRW</a><?> baseTable)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.yarn.server.timelineservice.storage.reader.<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader">AbstractTimelineStorageReader</a></h3> |
| <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html#augmentParams-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-">augmentParams</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html#defaultAugmentParams-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-">defaultAugmentParams</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html#getContext--">getContext</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html#lookupFlowContext-org.apache.hadoop.yarn.server.timelineservice.storage.apptoflow.AppToFlowRowKey-java.lang.String-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-">lookupFlowContext</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/AbstractTimelineStorageReader.html#validateParams--">validateParams</a></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#toString--" title="class or interface in java.lang">toString</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="TimelineEntityReader-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>TimelineEntityReader</h4> |
| <pre>protected TimelineEntityReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext ctxt, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters entityFilters, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve toRetrieve)</pre> |
| <div class="block">Instantiates a reader for multiple-entity reads.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctxt</code> - Reader context which defines the scope in which query has to be |
| made.</dd> |
| <dd><code>entityFilters</code> - Filters which limit the entities returned.</dd> |
| <dd><code>toRetrieve</code> - Data to retrieve for each entity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TimelineEntityReader-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TimelineEntityReader</h4> |
| <pre>protected TimelineEntityReader(org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext ctxt, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve toRetrieve)</pre> |
| <div class="block">Instantiates a reader for single-entity reads.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctxt</code> - Reader context which defines the scope in which query has to be |
| made.</dd> |
| <dd><code>toRetrieve</code> - Data to retrieve for each entity.</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="constructFilterListBasedOnFields-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructFilterListBasedOnFields</h4> |
| <pre>protected abstract org.apache.hadoop.hbase.filter.FilterList constructFilterListBasedOnFields(<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>> cfsInFields) |
| 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">Creates a <code>FilterList</code> based on fields, confs and metrics to |
| retrieve. This filter list will be set in Scan/Get objects to trim down |
| results fetched from HBase back-end storage. This is called only for |
| multiple entity reads.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cfsInFields</code> - column families in the fields</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>FilterList</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> - if any problem occurs while creating filter list.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="constructFilterListBasedOnFilters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructFilterListBasedOnFilters</h4> |
| <pre>protected abstract org.apache.hadoop.hbase.filter.FilterList constructFilterListBasedOnFilters() |
| 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">Creates a <code>FilterList</code> based on info, config and metric filters. This |
| filter list will be set in HBase Get to trim down results fetched from |
| HBase back-end storage.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>FilterList</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> - if any problem occurs while creating filter list.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataToRetrieve--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataToRetrieve</h4> |
| <pre>protected org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve getDataToRetrieve()</pre> |
| </li> |
| </ul> |
| <a name="getFilters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilters</h4> |
| <pre>protected org.apache.hadoop.yarn.server.timelineservice.reader.TimelineEntityFilters getFilters()</pre> |
| </li> |
| </ul> |
| <a name="createFiltersIfNull--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFiltersIfNull</h4> |
| <pre>protected void createFiltersIfNull()</pre> |
| <div class="block">Create a <code>TimelineEntityFilters</code> object with default values for |
| filters.</div> |
| </li> |
| </ul> |
| <a name="readEntity-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readEntity</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity readEntity(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn) |
| 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">Reads and deserializes a single timeline entity from the HBase storage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hbaseConf</code> - HBase Configuration.</dd> |
| <dd><code>conn</code> - HBase Connection.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <cite>TimelineEntity</cite> 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> - if there is any exception encountered while reading |
| entity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readEntities-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readEntities</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> readEntities(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn) |
| 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">Reads and deserializes a set of timeline entities from the HBase storage. |
| It goes through all the results available, and returns the number of |
| entries as specified in the limit in the entity's natural sort order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hbaseConf</code> - HBase Configuration.</dd> |
| <dd><code>conn</code> - HBase Connection.</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 exception is encountered while reading entities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTable</h4> |
| <pre>protected <a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTableRW.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTableRW</a><?> getTable()</pre> |
| <div class="block">Returns the main table to be used by the entity reader.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A reference to the table.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResult-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-org.apache.hadoop.hbase.filter.FilterList-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre>protected abstract org.apache.hadoop.hbase.client.Result getResult(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn, |
| org.apache.hadoop.hbase.filter.FilterList filterList) |
| 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">Fetches a <code>Result</code> instance for a single-entity read.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hbaseConf</code> - HBase Configuration.</dd> |
| <dd><code>conn</code> - HBase Connection.</dd> |
| <dd><code>filterList</code> - filter list which will be applied to HBase Get.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Result</code> instance or null if no such record is found.</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 exception is encountered while getting result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResults-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.Connection-org.apache.hadoop.hbase.filter.FilterList-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResults</h4> |
| <pre>protected abstract org.apache.hadoop.hbase.client.ResultScanner getResults(org.apache.hadoop.conf.Configuration hbaseConf, |
| org.apache.hadoop.hbase.client.Connection conn, |
| org.apache.hadoop.hbase.filter.FilterList filterList) |
| 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">Fetches a <code>ResultScanner</code> for a multi-entity read.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hbaseConf</code> - HBase Configuration.</dd> |
| <dd><code>conn</code> - HBase Connection.</dd> |
| <dd><code>filterList</code> - filter list which will be applied to HBase Scan.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>ResultScanner</code> instance.</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 exception is encountered while getting results.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseEntity-org.apache.hadoop.hbase.client.Result-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseEntity</h4> |
| <pre>protected abstract org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity parseEntity(org.apache.hadoop.hbase.client.Result result) |
| 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">Parses the result retrieved from HBase backend and convert it into a |
| <code>TimelineEntity</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>result</code> - Single row result of a Get/Scan.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <cite>TimelineEntity</cite> instance or null if the entity is |
| filtered.</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 exception is encountered while parsing entity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readMetrics-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.hbase.client.Result-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readMetrics</h4> |
| <pre>protected void readMetrics(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity entity, |
| org.apache.hadoop.hbase.client.Result result, |
| org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<?> columnPrefix) |
| 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">Helper method for reading and deserializing <code>TimelineMetric</code> objects |
| using the specified column prefix. The timeline metrics then are added to |
| the given timeline entity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - <code>TimelineEntity</code> object.</dd> |
| <dd><code>result</code> - <code>Result</code> object retrieved from backend.</dd> |
| <dd><code>columnPrefix</code> - Metric column prefix</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 exception is encountered while reading metrics.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSingleEntityRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSingleEntityRead</h4> |
| <pre>public boolean isSingleEntityRead()</pre> |
| <div class="block">Checks whether the reader has been created to fetch single entity or |
| multiple entities.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if query is for single entity, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTable-org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTableRW-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTable</h4> |
| <pre>protected void setTable(<a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/common/BaseTableRW.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.common">BaseTableRW</a><?> baseTable)</pre> |
| </li> |
| </ul> |
| <a name="hasField-java.util.EnumSet-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader.Field-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>protected boolean hasField(<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><org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader.Field> fieldsToRetrieve, |
| org.apache.hadoop.yarn.server.timelineservice.storage.TimelineReader.Field requiredField)</pre> |
| <div class="block">Check if we have a certain field amongst fields to retrieve. This method |
| checks against <code>TimelineReader.Field.ALL</code> as well because that would mean field |
| passed needs to be matched.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldsToRetrieve</code> - fields to be retrieved.</dd> |
| <dd><code>requiredField</code> - fields to be checked in fieldsToRetrieve.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if has the required field, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createFiltersFromColumnQualifiers-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFiltersFromColumnQualifiers</h4> |
| <pre>protected <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>> org.apache.hadoop.hbase.filter.FilterList createFiltersFromColumnQualifiers(org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> colPrefix, |
| <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>> columns)</pre> |
| <div class="block">Create a filter list of qualifier filters based on passed set of columns.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Describes the type of column prefix.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>colPrefix</code> - Column Prefix.</dd> |
| <dd><code>columns</code> - set of column qualifiers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>filter list.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createColQualifierPrefix-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createColQualifierPrefix</h4> |
| <pre>protected <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>> byte[] createColQualifierPrefix(org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> colPrefix, |
| <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> column)</pre> |
| </li> |
| </ul> |
| <a name="readRelationship-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.hbase.client.Result-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readRelationship</h4> |
| <pre>protected <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>> void readRelationship(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity entity, |
| org.apache.hadoop.hbase.client.Result result, |
| org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> prefix, |
| boolean isRelatedTo) |
| 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">Helper method for reading relationship.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Describes the type of column prefix.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - entity to fill.</dd> |
| <dd><code>result</code> - result from HBase.</dd> |
| <dd><code>prefix</code> - column prefix.</dd> |
| <dd><code>isRelatedTo</code> - if true, means relationship is to be added to |
| isRelatedTo, otherwise its added to relatesTo.</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 is encountered while reading result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readEvents-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.hbase.client.Result-org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>readEvents</h4> |
| <pre>protected static <T extends org.apache.hadoop.yarn.server.timelineservice.storage.common.BaseTable<T>> void readEvents(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity entity, |
| org.apache.hadoop.hbase.client.Result result, |
| org.apache.hadoop.yarn.server.timelineservice.storage.common.ColumnPrefix<T> prefix) |
| 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">Read events from the entity table or the application table. The column name |
| is of the form "eventId=timestamp=infoKey" where "infoKey" may be omitted |
| if there is no info associated with the event.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Describes the type of column prefix.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - entity to fill.</dd> |
| <dd><code>result</code> - HBase Result.</dd> |
| <dd><code>prefix</code> - column prefix.</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 is encountered while reading result.</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/TimelineEntityReader.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/storage/reader/EntityTypeReader.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReaderFactory.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage.reader"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/reader/TimelineEntityReader.html" target="_top">Frames</a></li> |
| <li><a href="TimelineEntityReader.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.yarn.server.timelineservice.storage.reader.AbstractTimelineStorageReader">Nested</a> | </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> |
