| <!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_181-google-v7) on Wed Aug 14 17:37:11 PDT 2019 --> |
| <title>ExternalSynchronization (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <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="ExternalSynchronization (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/ExternalSynchronization.html" target="_top">Frames</a></li> |
| <li><a href="ExternalSynchronization.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.beam.sdk.io.hadoop.format</div> |
| <h2 title="Interface ExternalSynchronization" class="title">Interface ExternalSynchronization</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HDFSSynchronization.html" title="class in org.apache.beam.sdk.io.hadoop.format">HDFSSynchronization</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ExternalSynchronization</span> |
| extends java.io.Serializable</pre> |
| <div class="block">Provides mechanism for acquiring locks related to the job. Serves as source of unique events |
| among the job.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskAttemptID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce">TaskAttemptID</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/ExternalSynchronization.html#acquireTaskAttemptIdLock-org.apache.hadoop.conf.Configuration-int-">acquireTaskAttemptIdLock</a></span>(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf, |
| int taskId)</code> |
| <div class="block">Creates unique <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskAttemptID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce"><code>TaskAttemptID</code></a> for given taskId.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce">TaskID</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/ExternalSynchronization.html#acquireTaskIdLock-org.apache.hadoop.conf.Configuration-">acquireTaskIdLock</a></span>(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Creates <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce"><code>TaskID</code></a> with unique id among given job.</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/beam/sdk/io/hadoop/format/ExternalSynchronization.html#releaseJobIdLock-org.apache.hadoop.conf.Configuration-">releaseJobIdLock</a></span>(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Deletes lock ids bounded with given job if any exists.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/ExternalSynchronization.html#tryAcquireJobLock-org.apache.hadoop.conf.Configuration-">tryAcquireJobLock</a></span>(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Tries to acquire lock for given job.</div> |
| </td> |
| </tr> |
| </table> |
| </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="tryAcquireJobLock-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tryAcquireJobLock</h4> |
| <pre>boolean tryAcquireJobLock(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| <div class="block">Tries to acquire lock for given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - configuration bounded with given job.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the lock was acquired, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="releaseJobIdLock-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>releaseJobIdLock</h4> |
| <pre>void releaseJobIdLock(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| <div class="block">Deletes lock ids bounded with given job if any exists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - hadoop configuration of given job.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acquireTaskIdLock-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acquireTaskIdLock</h4> |
| <pre><a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce">TaskID</a> acquireTaskIdLock(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| <div class="block">Creates <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce"><code>TaskID</code></a> with unique id among given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - hadoop configuration of given job.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce"><code>TaskID</code></a> with unique id among given job.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acquireTaskAttemptIdLock-org.apache.hadoop.conf.Configuration-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>acquireTaskAttemptIdLock</h4> |
| <pre><a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskAttemptID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce">TaskAttemptID</a> acquireTaskAttemptIdLock(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf, |
| int taskId)</pre> |
| <div class="block">Creates unique <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskAttemptID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce"><code>TaskAttemptID</code></a> for given taskId.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - configuration of given task and job</dd> |
| <dd><code>taskId</code> - id of the task</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Unique <a href="https://static.javadoc.io/org.apache.hadoop/hadoop-mapreduce-client-core/2.7.3/org/apache/hadoop/mapreduce/TaskAttemptID.html?is-external=true" title="class or interface in org.apache.hadoop.mapreduce"><code>TaskAttemptID</code></a> for given taskId.</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="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>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/ExternalSynchronization.html" target="_top">Frames</a></li> |
| <li><a href="ExternalSynchronization.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 ======= --> |
| </body> |
| </html> |