| <!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 --> |
| <title>ByteKeyRangeTracker (Apache Beam 2.47.0)</title> |
| <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="ByteKeyRangeTracker (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="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/transforms/splittabledofn/GrowableOffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html" target="_top">Frames</a></li> |
| <li><a href="ByteKeyRangeTracker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker">Nested</a> | </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.transforms.splittabledofn</div> |
| <h2 title="Class ByteKeyRangeTracker" class="title">Class ByteKeyRangeTracker</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.transforms.splittabledofn.ByteKeyRangeTracker</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.HasProgress</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ByteKeyRangeTracker</span> |
| extends <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>> |
| implements <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.HasProgress</a></pre> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>RestrictionTracker</code></a> for claiming <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range"><code>ByteKey</code></a>s in a <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range"><code>ByteKeyRange</code></a> in a |
| monotonically increasing fashion. The range is a semi-open bounded interval [startKey, endKey) |
| where the limits are both represented by <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html#EMPTY"><code>ByteKey.EMPTY</code></a>. |
| |
| <p>Note, one can complete a range by claiming the <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html#EMPTY"><code>ByteKey.EMPTY</code></a> once one runs out of keys |
| to process.</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.beam.sdk.transforms.splittabledofn.RestrictionTracker"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.splittabledofn.<a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.HasProgress</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html" title="enum in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.IsBounded</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.Progress.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.Progress</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.TruncateResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.TruncateResult</a><<a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.TruncateResult.html" title="type parameter in RestrictionTracker.TruncateResult">RestrictionT</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#checkDone--">checkDone</a></span>()</code> |
| <div class="block">Checks whether the restriction has been fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#currentRestriction--">currentRestriction</a></span>()</code> |
| <div class="block">Returns a restriction accurately describing the full range of work the current <code>DoFn.ProcessElement</code> call will do, including already completed work.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.Progress.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.Progress</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#getProgress--">getProgress</a></span>()</code> |
| <div class="block">A representation for the amount of known completed and known remaining work.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html" title="enum in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.IsBounded</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#isBounded--">isBounded</a></span>()</code> |
| <div class="block">Return the boundedness of the current restriction.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">ByteKeyRangeTracker</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#of-org.apache.beam.sdk.io.range.ByteKeyRange-">of</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a> range)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#tryClaim-org.apache.beam.sdk.io.range.ByteKey-">tryClaim</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a> key)</code> |
| <div class="block">Attempts to claim the given key.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/SplitResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">SplitResult</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#trySplit-double-">trySplit</a></span>(double fractionOfRemainder)</code> |
| <div class="block">Splits current restriction based on <code>fractionOfRemainder</code>.</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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="of-org.apache.beam.sdk.io.range.ByteKeyRange-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">ByteKeyRangeTracker</a> of(<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a> range)</pre> |
| </li> |
| </ul> |
| <a name="currentRestriction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentRestriction</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a> currentRestriction()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#currentRestriction--">RestrictionTracker</a></code></span></div> |
| <div class="block">Returns a restriction accurately describing the full range of work the current <code>DoFn.ProcessElement</code> call will do, including already completed work. |
| |
| <p>The current restriction returned by method may be updated dynamically due to due to |
| concurrent invocation of other methods of the <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>RestrictionTracker</code></a>, For example, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#trySplit-double-"><code>RestrictionTracker.trySplit(double)</code></a>. |
| |
| <p>This method is <b>required</b> to be implemented.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#currentRestriction--">currentRestriction</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="trySplit-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trySplit</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/SplitResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">SplitResult</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>> trySplit(double fractionOfRemainder)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#trySplit-double-">RestrictionTracker</a></code></span></div> |
| <div class="block">Splits current restriction based on <code>fractionOfRemainder</code>. |
| |
| <p>If splitting the current restriction is possible, the current restriction is split into a |
| primary and residual restriction pair. This invocation updates the <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#currentRestriction--"><code>RestrictionTracker.currentRestriction()</code></a> to be the primary restriction effectively having the current <code>DoFn.ProcessElement</code> execution responsible for performing the work that the primary restriction |
| represents. The residual restriction will be executed in a separate <code>DoFn.ProcessElement</code> |
| invocation (likely in a different process). The work performed by executing the primary and |
| residual restrictions as separate <code>DoFn.ProcessElement</code> invocations MUST be equivalent to |
| the work performed as if this split never occurred. |
| |
| <p>The <code>fractionOfRemainder</code> should be used in a best effort manner to choose a primary |
| and residual restriction based upon the fraction of the remaining work that the current <code>DoFn.ProcessElement</code> invocation is responsible for. For example, if a <code>DoFn.ProcessElement</code> was reading a file with a restriction representing the offset range <code>[100, 200)</code> and has processed up to offset 130 with a <code>fractionOfRemainder</code> of <code>0.7</code>, the primary and residual restrictions returned would be <code>[100, 179), [179, 200)</code> |
| (note: <code>currentOffset + fractionOfRemainder * remainingWork = 130 + 0.7 * 70 = 179</code>). |
| |
| <p><code>fractionOfRemainder = 0</code> means a checkpoint is required. |
| |
| <p>The API is recommended to be implemented for a batch pipeline to improve parallel processing |
| performance. |
| |
| <p>The API is recommended to be implemented for batch pipeline given that it is very important |
| for pipeline scaling and end to end pipeline execution. |
| |
| <p>The API is required to be implemented for a streaming pipeline.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#trySplit-double-">trySplit</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fractionOfRemainder</code> - A hint as to the fraction of work the primary restriction should |
| represent based upon the current known remaining amount of work.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/SplitResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>SplitResult</code></a> if a split was possible, otherwise returns <code>null</code>. If the |
| <code>fractionOfRemainder == 0</code>, a <code>null</code> result MUST imply that the restriction |
| tracker is done and there is no more work left to do.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tryClaim-org.apache.beam.sdk.io.range.ByteKey-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tryClaim</h4> |
| <pre>public boolean tryClaim(<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a> key)</pre> |
| <div class="block">Attempts to claim the given key. |
| |
| <p>Must be larger than the last attempted key. Since this restriction tracker represents a |
| range over a semi-open bounded interval <code>[start, end)</code>, the last key that was attempted |
| may have failed but still have consumed the interval <code>[lastAttemptedKey, end)</code> since this |
| range tracker processes keys in a monotonically increasing order. Note that passing in <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html#EMPTY"><code>ByteKey.EMPTY</code></a> claims all keys to the end of range and can only be claimed once.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#tryClaim-PositionT-">tryClaim</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the key was successfully claimed, <code>false</code> if it is outside the |
| current <a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range"><code>ByteKeyRange</code></a> of this tracker.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkDone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkDone</h4> |
| <pre>public void checkDone() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#checkDone--">RestrictionTracker</a></code></span></div> |
| <div class="block">Checks whether the restriction has been fully processed. |
| |
| <p>Called by the SDK harness after <code>DoFn.ProcessElement</code> returns. |
| |
| <p>Must throw an exception with an informative error message, if there is still any unclaimed |
| work remaining in the restriction. |
| |
| <p>This method is <b>required</b> to be implemented in order to prevent data loss during SDK |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#checkDone--">checkDone</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isBounded--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBounded</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html" title="enum in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.IsBounded</a> isBounded()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#isBounded--">RestrictionTracker</a></code></span></div> |
| <div class="block">Return the boundedness of the current restriction. If the current restriction represents a |
| finite amount of work, it should return <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html#BOUNDED"><code>RestrictionTracker.IsBounded.BOUNDED</code></a>. Otherwise, it should return |
| <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html#UNBOUNDED"><code>RestrictionTracker.IsBounded.UNBOUNDED</code></a>. |
| |
| <p>It is valid to return <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html#BOUNDED"><code>RestrictionTracker.IsBounded.BOUNDED</code></a> after returning <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html#UNBOUNDED"><code>RestrictionTracker.IsBounded.UNBOUNDED</code></a> |
| once the end of a restriction is discovered. It is not valid to return <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html#UNBOUNDED"><code>RestrictionTracker.IsBounded.UNBOUNDED</code></a> after returning <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html#BOUNDED"><code>RestrictionTracker.IsBounded.BOUNDED</code></a>. |
| |
| <p>This method is <b>required</b> to be implemented.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#isBounded--">isBounded</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>,<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProgress--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getProgress</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.Progress.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.Progress</a> getProgress()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html#getProgress--">RestrictionTracker.HasProgress</a></code></span></div> |
| <div class="block">A representation for the amount of known completed and known remaining work. |
| |
| <p>It is up to each restriction tracker to convert between their natural representation of |
| completed and remaining work and the <code>double</code> representation. For example: |
| |
| <ul> |
| <li>Block based file source (e.g. Avro): The number of bytes from the beginning of the |
| restriction to the current block and the number of bytes from the current block to the |
| end of the restriction. |
| <li>Pull based queue based source (e.g. Pubsub): The local/global size available in number |
| of messages or number of <code>message bytes</code> that have processed and the number of |
| messages or number of <code>message bytes</code> that are outstanding. |
| <li>Key range based source (e.g. BigQuery, Bigtable, ...): Scale the start key to be one |
| and end key to be zero and interpolate the position of the next splittable key as a |
| position. If information about the probability density function or cumulative |
| distribution function is available, work completed and work remaining interpolation can |
| be improved. Alternatively, if the number of encoded bytes for the keys and values is |
| known for the key range, the number of completed and remaining bytes can be used. |
| </ul> |
| |
| <p>The work completed and work remaining must be of the same scale whether that be number of |
| messages or number of bytes and should never represent two distinct unit types.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html#getProgress--">getProgress</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.HasProgress</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="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/transforms/splittabledofn/GrowableOffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html" target="_top">Frames</a></li> |
| <li><a href="ByteKeyRangeTracker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker">Nested</a> | </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> |
