| <!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>org.apache.beam.sdk.transforms.splittabledofn (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="org.apache.beam.sdk.transforms.splittabledofn (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/splittabledofn/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <p>@DefaultAnnotation(value=<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/NonNull.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">org.checkerframework.checker.nullness.qual.NonNull.class</a>) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.transforms.splittabledofn</h1> |
| <div class="docSummary"> |
| <div class="block">Defines utilities related to <a href="https://s.apache.org/splittable-do-fn">splittable</a> |
| <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/GrowableOffsetRangeTracker.RangeEndEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">GrowableOffsetRangeTracker.RangeEndEstimator</a></td> |
| <td class="colLast"> |
| <div class="block">Provides the estimated end offset of the range.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/HasDefaultTracker.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">HasDefaultTracker</a><RestrictionT extends <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/HasDefaultTracker.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">HasDefaultTracker</a><RestrictionT,TrackerT>,TrackerT extends <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><RestrictionT,?>></td> |
| <td class="colLast"> |
| <div class="block">Interface for restrictions for which a default implementation of <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewTracker</code></a> is available, depending only on the restriction |
| itself.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/HasDefaultWatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">HasDefaultWatermarkEstimator</a><WatermarkEstimatorStateT,WatermarkEstimatorT extends <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimator</a><WatermarkEstimatorStateT>></td> |
| <td class="colLast"> |
| <div class="block">Interface for watermark estimator state for which a default implementation of <code>DoFn.NewWatermarkEstimator</code> is available, depending only on the watermark estimator state itself.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ManualWatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">ManualWatermarkEstimator</a><WatermarkEstimatorStateT></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><code>WatermarkEstimator</code></a> which is controlled manually from within a <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.HasProgress.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.HasProgress</a></td> |
| <td class="colLast"> |
| <div class="block">All <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>RestrictionTracker</code></a>s SHOULD implement this interface to improve auto-scaling and |
| splitting performance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/TimestampObservingWatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">TimestampObservingWatermarkEstimator</a><WatermarkEstimatorStateT></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><code>WatermarkEstimator</code></a> that observes the timestamps of all records output from a <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimator</a><WatermarkEstimatorStateT></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><code>WatermarkEstimator</code></a> which is used for estimating output watermarks of a splittable |
| <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">ByteKeyRangeTracker</a></td> |
| <td class="colLast"> |
| <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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/GrowableOffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">GrowableOffsetRangeTracker</a></td> |
| <td class="colLast"> |
| <div class="block">An <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>OffsetRangeTracker</code></a> for tracking a growable offset range.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">OffsetRangeTracker</a></td> |
| <td class="colLast"> |
| <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 offsets in an <a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRange.html" title="class in org.apache.beam.sdk.io.range"><code>OffsetRange</code></a> in a monotonically |
| increasing fashion.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><RestrictionT,PositionT></td> |
| <td class="colLast"> |
| <div class="block">Manages access to the restriction and keeps track of its claimed part for a <a |
| href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.Progress.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.Progress</a></td> |
| <td class="colLast"> |
| <div class="block">A representation for the amount of known completed and remaining work.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.TruncateResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.TruncateResult</a><RestrictionT></td> |
| <td class="colLast"> |
| <div class="block">A representation of the truncate result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/SplitResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">SplitResult</a><RestrictionT></td> |
| <td class="colLast"> |
| <div class="block">A representation of a split result.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimators.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimators</a></td> |
| <td class="colLast"> |
| <div class="block">A set of <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><code>WatermarkEstimator</code></a>s that users can use to advance the output watermark for their |
| associated <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>splittable DoFn</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimators.Manual.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimators.Manual</a></td> |
| <td class="colLast"> |
| <div class="block">Concrete implementation of a <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ManualWatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><code>ManualWatermarkEstimator</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimators.MonotonicallyIncreasing.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimators.MonotonicallyIncreasing</a></td> |
| <td class="colLast"> |
| <div class="block">A watermark estimator that observes timestamps of records output from a DoFn reporting the |
| timestamp of the last element seen as the current watermark.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimators.WallTime.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimators.WallTime</a></td> |
| <td class="colLast"> |
| <div class="block">A watermark estimator that tracks wall time.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.IsBounded.html" title="enum in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker.IsBounded</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.transforms.splittabledofn Description">Package org.apache.beam.sdk.transforms.splittabledofn Description</h2> |
| <div class="block">Defines utilities related to <a href="https://s.apache.org/splittable-do-fn">splittable</a> |
| <a href="../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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><a href="../../../../../../org/apache/beam/sdk/transforms/resourcehints/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/splittabledofn/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
