| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:11:53 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FileSystemTimelineWriterImpl (Apache Hadoop YARN Timeline Service 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FileSystemTimelineWriterImpl (Apache Hadoop YARN Timeline Service 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FileSystemTimelineWriterImpl.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/FileSystemTimelineReaderImpl.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/NoOpTimelineReaderImpl.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html" target="_top">Frames</a></li> |
| <li><a href="FileSystemTimelineWriterImpl.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.server.timelineservice.storage</div> |
| <h2 title="Class FileSystemTimelineWriterImpl" class="title">Class FileSystemTimelineWriterImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.service.AbstractService</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, org.apache.hadoop.service.Service, <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">FileSystemTimelineWriterImpl</span> |
| extends org.apache.hadoop.service.AbstractService |
| implements <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineWriter</a></pre> |
| <div class="block">This implements a FileSystem based backend for storing application timeline |
| information. This implementation may not provide a complete implementation of |
| all the necessary features. This implementation is provided solely for basic |
| testing purposes, and should not be used in a non-test situation.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.service.Service"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service</h3> |
| <code>org.apache.hadoop.service.Service.STATE</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#DEFAULT_TIMELINE_FS_WRITER_NUM_RETRIES">DEFAULT_TIMELINE_FS_WRITER_NUM_RETRIES</a></span></code> </td> |
| </tr> |
| <tr 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/storage/FileSystemTimelineWriterImpl.html#DEFAULT_TIMELINE_FS_WRITER_RETRY_INTERVAL_MS">DEFAULT_TIMELINE_FS_WRITER_RETRY_INTERVAL_MS</a></span></code> </td> |
| </tr> |
| <tr 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/storage/FileSystemTimelineWriterImpl.html#ENTITIES_DIR">ENTITIES_DIR</a></span></code> </td> |
| </tr> |
| <tr 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/storage/FileSystemTimelineWriterImpl.html#TIMELINE_FS_WRITER_NUM_RETRIES">TIMELINE_FS_WRITER_NUM_RETRIES</a></span></code> </td> |
| </tr> |
| <tr 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/storage/FileSystemTimelineWriterImpl.html#TIMELINE_FS_WRITER_RETRY_INTERVAL_MS">TIMELINE_FS_WRITER_RETRY_INTERVAL_MS</a></span></code> </td> |
| </tr> |
| <tr 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/storage/FileSystemTimelineWriterImpl.html#TIMELINE_SERVICE_STORAGE_DIR_ROOT">TIMELINE_SERVICE_STORAGE_DIR_ROOT</a></span></code> |
| <div class="block">Config param for timeline service storage tmp root for FILE YARN-3264.</div> |
| </td> |
| </tr> |
| <tr 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/storage/FileSystemTimelineWriterImpl.html#TIMELINE_SERVICE_STORAGE_EXTENSION">TIMELINE_SERVICE_STORAGE_EXTENSION</a></span></code> |
| <div class="block">Default extension for output files.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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>org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#aggregate-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineAggregationTrack-">aggregate</a></span>(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity data, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineAggregationTrack.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineAggregationTrack</a> track)</code> |
| <div class="block">Aggregates the entity information to the timeline store based on which |
| track this entity is to be rolled up to The tracks along which aggregations |
| are to be done are given by <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineAggregationTrack.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage"><code>TimelineAggregationTrack</code></a> |
| |
| Any errors occurring for individual write request objects will be reported |
| in the response.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#flush--">flush</a></span>()</code> |
| <div class="block">Flushes the data to the backend storage.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#serviceInit-org.apache.hadoop.conf.Configuration-">serviceInit</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#serviceStart--">serviceStart</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain-">write</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/collector/TimelineCollectorContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.collector">TimelineCollectorContext</a> context, |
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain domain)</code> |
| <div class="block">Stores <code>TimelineDomain</code> object to the timeline |
| store.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html#write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities-org.apache.hadoop.security.UserGroupInformation-">write</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/collector/TimelineCollectorContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.collector">TimelineCollectorContext</a> context, |
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities, |
| org.apache.hadoop.security.UserGroupInformation callerUgi)</code> |
| <div class="block">Stores the entire information in <code>TimelineEntities</code> to the timeline |
| store.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/FileSystemTimelineWriterImpl.html#writeFile-org.apache.hadoop.fs.Path-byte:A-">writeFile</a></span>(org.apache.hadoop.fs.Path outputPath, |
| byte[] data)</code> |
| <div class="block">In order to make this writeInternal atomic as a part of writeInternal |
| we will first writeInternal data to .tmp file and then rename it.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.service.AbstractService"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.service.AbstractService</h3> |
| <code>close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.service.Service"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.service.Service</h3> |
| <code>close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="TIMELINE_SERVICE_STORAGE_DIR_ROOT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TIMELINE_SERVICE_STORAGE_DIR_ROOT</h4> |
| <pre>public static final <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> TIMELINE_SERVICE_STORAGE_DIR_ROOT</pre> |
| <div class="block">Config param for timeline service storage tmp root for FILE YARN-3264.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.TIMELINE_SERVICE_STORAGE_DIR_ROOT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TIMELINE_FS_WRITER_NUM_RETRIES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TIMELINE_FS_WRITER_NUM_RETRIES</h4> |
| <pre>public static final <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> TIMELINE_FS_WRITER_NUM_RETRIES</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.TIMELINE_FS_WRITER_NUM_RETRIES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_TIMELINE_FS_WRITER_NUM_RETRIES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_TIMELINE_FS_WRITER_NUM_RETRIES</h4> |
| <pre>public static final int DEFAULT_TIMELINE_FS_WRITER_NUM_RETRIES</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.DEFAULT_TIMELINE_FS_WRITER_NUM_RETRIES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TIMELINE_FS_WRITER_RETRY_INTERVAL_MS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TIMELINE_FS_WRITER_RETRY_INTERVAL_MS</h4> |
| <pre>public static final <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> TIMELINE_FS_WRITER_RETRY_INTERVAL_MS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.TIMELINE_FS_WRITER_RETRY_INTERVAL_MS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_TIMELINE_FS_WRITER_RETRY_INTERVAL_MS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_TIMELINE_FS_WRITER_RETRY_INTERVAL_MS</h4> |
| <pre>public static final long DEFAULT_TIMELINE_FS_WRITER_RETRY_INTERVAL_MS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.DEFAULT_TIMELINE_FS_WRITER_RETRY_INTERVAL_MS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENTITIES_DIR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENTITIES_DIR</h4> |
| <pre>public static final <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> ENTITIES_DIR</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.ENTITIES_DIR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TIMELINE_SERVICE_STORAGE_EXTENSION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TIMELINE_SERVICE_STORAGE_EXTENSION</h4> |
| <pre>public static final <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> TIMELINE_SERVICE_STORAGE_EXTENSION</pre> |
| <div class="block">Default extension for output files.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.timelineservice.storage.FileSystemTimelineWriterImpl.TIMELINE_SERVICE_STORAGE_EXTENSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities-org.apache.hadoop.security.UserGroupInformation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse write(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/collector/TimelineCollectorContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.collector">TimelineCollectorContext</a> context, |
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities, |
| org.apache.hadoop.security.UserGroupInformation callerUgi) |
| 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities-org.apache.hadoop.security.UserGroupInformation-">TimelineWriter</a></code></span></div> |
| <div class="block">Stores the entire information in <code>TimelineEntities</code> to the timeline |
| store. Any errors occurring for individual write request objects will be |
| reported in the response.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities-org.apache.hadoop.security.UserGroupInformation-">write</a></code> in interface <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineWriter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - a <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/collector/TimelineCollectorContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.collector"><code>TimelineCollectorContext</code></a></dd> |
| <dd><code>entities</code> - a <code>TimelineEntities</code> object.</dd> |
| <dd><code>callerUgi</code> - <code>UserGroupInformation</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>TimelineWriteResponse</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 there is any exception encountered while storing or |
| writing entities to the back end storage.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse write(<a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/collector/TimelineCollectorContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.collector">TimelineCollectorContext</a> context, |
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain domain) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain-">TimelineWriter</a></code></span></div> |
| <div class="block">Stores <code>TimelineDomain</code> object to the timeline |
| store. Any errors occurring for individual write request objects will be |
| reported in the response.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#write-org.apache.hadoop.yarn.server.timelineservice.collector.TimelineCollectorContext-org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain-">write</a></code> in interface <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineWriter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - a <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/collector/TimelineCollectorContext.html" title="class in org.apache.hadoop.yarn.server.timelineservice.collector"><code>TimelineCollectorContext</code></a></dd> |
| <dd><code>domain</code> - a <code>TimelineDomain</code> object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>TimelineWriteResponse</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 there is any exception encountered while storing or |
| writing entities to the back end storage.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="aggregate-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineAggregationTrack-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aggregate</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse aggregate(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity data, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineAggregationTrack.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineAggregationTrack</a> track) |
| 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#aggregate-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineAggregationTrack-">TimelineWriter</a></code></span></div> |
| <div class="block">Aggregates the entity information to the timeline store based on which |
| track this entity is to be rolled up to The tracks along which aggregations |
| are to be done are given by <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineAggregationTrack.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage"><code>TimelineAggregationTrack</code></a> |
| |
| Any errors occurring for individual write request objects will be reported |
| in the response.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#aggregate-org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity-org.apache.hadoop.yarn.server.timelineservice.storage.TimelineAggregationTrack-">aggregate</a></code> in interface <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineWriter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - a <code>TimelineEntity</code> object |
| a <a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineAggregationTrack.html" title="enum in org.apache.hadoop.yarn.server.timelineservice.storage"><code>TimelineAggregationTrack</code></a> enum |
| value.</dd> |
| <dd><code>track</code> - Specifies the track or dimension along which aggregation would |
| occur. Includes USER, FLOW, QUEUE, etc.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>TimelineWriteResponse</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 there is any exception encountered while aggregating |
| entities to the backend storage.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="serviceInit-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceInit</h4> |
| <pre>public void serviceInit(org.apache.hadoop.conf.Configuration conf) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>serviceInit</code> in class <code>org.apache.hadoop.service.AbstractService</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="serviceStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceStart</h4> |
| <pre>public void serviceStart() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>serviceStart</code> in class <code>org.apache.hadoop.service.AbstractService</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flush--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>public void flush() |
| 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#flush--">TimelineWriter</a></code></span></div> |
| <div class="block">Flushes the data to the backend storage. Whatever may be buffered will be |
| written to the storage when the method returns. This may be a potentially |
| time-consuming operation, and should be used judiciously.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html#flush--">flush</a></code> in interface <code><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/TimelineWriter.html" title="interface in org.apache.hadoop.yarn.server.timelineservice.storage">TimelineWriter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is any exception encountered while flushing |
| entities to the backend storage.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeFile-org.apache.hadoop.fs.Path-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeFile</h4> |
| <pre>protected void writeFile(org.apache.hadoop.fs.Path outputPath, |
| byte[] data) |
| 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">In order to make this writeInternal atomic as a part of writeInternal |
| we will first writeInternal data to .tmp file and then rename it. |
| Here we are assuming that rename is atomic for underlying file system.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FileSystemTimelineWriterImpl.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/FileSystemTimelineReaderImpl.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/timelineservice/storage/NoOpTimelineReaderImpl.html" title="class in org.apache.hadoop.yarn.server.timelineservice.storage"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/timelineservice/storage/FileSystemTimelineWriterImpl.html" target="_top">Frames</a></li> |
| <li><a href="FileSystemTimelineWriterImpl.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
