| <!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:24 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DocumentStoreUtils (Apache Hadoop YARN TimelineService DocumentStore 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="DocumentStoreUtils (Apache Hadoop YARN TimelineService DocumentStore 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/DocumentStoreUtils.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/documentstore/DocumentStoreTimelineWriterImpl.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html" target="_top">Frames</a></li> |
| <li><a href="DocumentStoreUtils.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.timelineservice.documentstore</div> |
| <h2 title="Class DocumentStoreUtils" class="title">Class DocumentStoreUtils</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.yarn.server.timelineservice.documentstore.DocumentStoreUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">DocumentStoreUtils</span> |
| extends <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></pre> |
| <div class="block">This class consists of all the utils required for reading or writing |
| documents for a <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.documentstore.lib"><code>DocumentStoreVendor</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="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>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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/documentstore/DocumentStoreUtils.html#applyConfigFilter-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-java.util.Map-">applyConfigFilter</a></span>(org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList configsToRetrieve, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> configs)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <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/documentstore/DocumentStoreUtils.html#constructFlowActivityDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-long-">constructFlowActivityDocId</a></span>(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext, |
| long eventTimestamp)</code> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/flowactivity/FlowActivityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.flowactivity"><code>FlowActivityDocument</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <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/documentstore/DocumentStoreUtils.html#constructFlowRunDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-">constructFlowRunDocId</a></span>(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext)</code> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/flowrun/FlowRunDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.flowrun"><code>FlowRunDocument</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <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/documentstore/DocumentStoreUtils.html#constructTimelineEntityDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-java.lang.String-">constructTimelineEntityDocId</a></span>(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext, |
| <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> type)</code> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity"><code>TimelineEntityDocument</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <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/documentstore/DocumentStoreUtils.html#constructTimelineEntityDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-java.lang.String-java.lang.String-">constructTimelineEntityDocId</a></span>(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext, |
| <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> type, |
| <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> id)</code> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity"><code>TimelineEntityDocument</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static com.microsoft.azure.cosmosdb.rx.AsyncDocumentClient</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#createCosmosDBAsyncClient-org.apache.hadoop.conf.Configuration-">createCosmosDBAsyncClient</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Creates CosmosDB Async Document Client.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static 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/documentstore/DocumentStoreUtils.html#createEntityToBeReturned-org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity.TimelineEntityDocument-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-">createEntityToBeReturned</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity">TimelineEntityDocument</a> timelineEntityDocument, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve dataToRetrieve)</code> |
| <div class="block">Creates the final entity to be returned as the result.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static 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/documentstore/DocumentStoreUtils.html#createEntityToBeReturned-org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity.TimelineEntityDocument-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-">createEntityToBeReturned</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity">TimelineEntityDocument</a> timelineEntityDocument, |
| org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList confsToRetrieve, |
| org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList metricsToRetrieve)</code> |
| <div class="block">Creates the final entity to be returned as the result.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#fetchEvent-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-java.lang.String-">fetchEvent</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity timelineEntity, |
| <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> eventType)</code> |
| <div class="block">Retrieves a <code>TimelineEvent</code> from <code>TimelineEntity.events</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <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/documentstore/DocumentStoreUtils.html#getCosmosDBDatabaseName-org.apache.hadoop.conf.Configuration-">getCosmosDBDatabaseName</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.documentstore.lib">DocumentStoreVendor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#getStoreVendor-org.apache.hadoop.conf.Configuration-">getStoreVendor</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Retrieves <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.documentstore.lib"><code>DocumentStoreVendor</code></a> configured.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#getTopOfTheDayTimestamp-long-">getTopOfTheDayTimestamp</a></span>(long timeStamp)</code> |
| <div class="block">Returns the timestamp of the day's start (which is midnight 00:00:00 AM) |
| for a given input timestamp.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#isNullOrEmpty-java.lang.String...-">isNullOrEmpty</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>... values)</code> |
| <div class="block">Checks if the string is null or empty.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <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.TimelineMetric></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#transformMetrics-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-java.util.Map-">transformMetrics</a></span>(org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList metricsToRetrieve, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineMetricSubDoc.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity">TimelineMetricSubDoc</a>>> metrics)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html#validateCosmosDBConf-org.apache.hadoop.conf.Configuration-">validateCosmosDBConf</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Checks whether the cosmosdb conf are set properly in yarn-site.xml conf.</div> |
| </td> |
| </tr> |
| </table> |
| <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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="validateCosmosDBConf-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateCosmosDBConf</h4> |
| <pre>public static void validateCosmosDBConf(org.apache.hadoop.conf.Configuration conf) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Checks whether the cosmosdb conf are set properly in yarn-site.xml conf.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - related to yarn</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if required config properties are missing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStoreVendor-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoreVendor</h4> |
| <pre>public static <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.documentstore.lib">DocumentStoreVendor</a> getStoreVendor(org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Retrieves <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.documentstore.lib"><code>DocumentStoreVendor</code></a> configured.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - related to yarn</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.documentstore.lib"><code>DocumentStoreVendor</code></a> that is configured, else |
| uses <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/lib/DocumentStoreVendor.html#COSMOS_DB"><code>DocumentStoreVendor.COSMOS_DB</code></a> as default</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fetchEvent-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchEvent</h4> |
| <pre>public static org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent fetchEvent(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity timelineEntity, |
| <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> eventType)</pre> |
| <div class="block">Retrieves a <code>TimelineEvent</code> from <code>TimelineEntity.events</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timelineEntity</code> - from which the set of events are examined.</dd> |
| <dd><code>eventType</code> - that has to be checked.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>TimelineEvent</code> if found else null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNullOrEmpty-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNullOrEmpty</h4> |
| <pre>public static boolean isNullOrEmpty(<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>... values)</pre> |
| <div class="block">Checks if the string is null or empty.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - array of string to be checked</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>false if any of the string is null or empty else true</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createCosmosDBAsyncClient-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createCosmosDBAsyncClient</h4> |
| <pre>public static com.microsoft.azure.cosmosdb.rx.AsyncDocumentClient createCosmosDBAsyncClient(org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Creates CosmosDB Async Document Client.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - to retrieve cosmos db endpoint and key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>async document client for CosmosDB</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTopOfTheDayTimestamp-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopOfTheDayTimestamp</h4> |
| <pre>public static long getTopOfTheDayTimestamp(long timeStamp)</pre> |
| <div class="block">Returns the timestamp of the day's start (which is midnight 00:00:00 AM) |
| for a given input timestamp.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeStamp</code> - Timestamp.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>timestamp of that day's beginning (midnight)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="constructTimelineEntityDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructTimelineEntityDocId</h4> |
| <pre>public static <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> constructTimelineEntityDocId(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext, |
| <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> type)</pre> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity"><code>TimelineEntityDocument</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collectorContext</code> - of the timeline writer</dd> |
| <dd><code>type</code> - of the entity</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>composite key delimited with !</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="constructTimelineEntityDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructTimelineEntityDocId</h4> |
| <pre>public static <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> constructTimelineEntityDocId(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext, |
| <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> type, |
| <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> id)</pre> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity"><code>TimelineEntityDocument</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collectorContext</code> - of the timeline writer</dd> |
| <dd><code>type</code> - of the entity</dd> |
| <dd><code>id</code> - of the entity</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>composite key delimited with !</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="constructFlowRunDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructFlowRunDocId</h4> |
| <pre>public static <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> constructFlowRunDocId(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext)</pre> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/flowrun/FlowRunDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.flowrun"><code>FlowRunDocument</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collectorContext</code> - of the timeline writer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>composite key delimited with !</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="constructFlowActivityDocId-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructFlowActivityDocId</h4> |
| <pre>public static <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> constructFlowActivityDocId(org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext collectorContext, |
| long eventTimestamp)</pre> |
| <div class="block">Creates a composite key for storing <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/flowactivity/FlowActivityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.flowactivity"><code>FlowActivityDocument</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collectorContext</code> - of the timeline writer</dd> |
| <dd><code>eventTimestamp</code> - of the timeline entity</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>composite key delimited with !</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCosmosDBDatabaseName-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCosmosDBDatabaseName</h4> |
| <pre>public static <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> getCosmosDBDatabaseName(org.apache.hadoop.conf.Configuration conf)</pre> |
| </li> |
| </ul> |
| <a name="createEntityToBeReturned-org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity.TimelineEntityDocument-org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityToBeReturned</h4> |
| <pre>public static org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity createEntityToBeReturned(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity">TimelineEntityDocument</a> timelineEntityDocument, |
| org.apache.hadoop.yarn.server.timelineservice.reader.TimelineDataToRetrieve dataToRetrieve)</pre> |
| <div class="block">Creates the final entity to be returned as the result.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timelineEntityDocument</code> - which has all the information for the entity</dd> |
| <dd><code>dataToRetrieve</code> - specifies filters and fields to retrieve</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>TimelineEntity</code> as the result</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createEntityToBeReturned-org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity.TimelineEntityDocument-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEntityToBeReturned</h4> |
| <pre>public static org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity createEntityToBeReturned(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineEntityDocument.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity">TimelineEntityDocument</a> timelineEntityDocument, |
| org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList confsToRetrieve, |
| org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList metricsToRetrieve)</pre> |
| <div class="block">Creates the final entity to be returned as the result.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timelineEntityDocument</code> - which has all the information for the entity</dd> |
| <dd><code>confsToRetrieve</code> - specifies config filters to be applied</dd> |
| <dd><code>metricsToRetrieve</code> - specifies metric filters to be applied</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>TimelineEntity</code> as the result</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transformMetrics-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transformMetrics</h4> |
| <pre>public static <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.TimelineMetric> transformMetrics(org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList metricsToRetrieve, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/documentstore/collection/document/entity/TimelineMetricSubDoc.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.entity">TimelineMetricSubDoc</a>>> metrics)</pre> |
| </li> |
| </ul> |
| <a name="applyConfigFilter-org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>applyConfigFilter</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> applyConfigFilter(org.apache.hadoop.yarn.server.timelineservice.reader.filter.TimelineFilterList configsToRetrieve, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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>> configs)</pre> |
| </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/DocumentStoreUtils.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/documentstore/DocumentStoreTimelineWriterImpl.html" title="class in org.apache.hadoop.yarn.server.timelineservice.documentstore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/documentstore/DocumentStoreUtils.html" target="_top">Frames</a></li> |
| <li><a href="DocumentStoreUtils.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
