Google Git
Sign in
apache / beam-site / 8066db78465c0d76bfe854be06941aea4657c8d5 / . / javadoc / javadoc / org / apache / beam / sdk / transforms / splittabledofn / ByteKeyRangeTracker.html
blob: 99cede2ddc85f85eed9ef683485f234da8c729ff [file] [log] [blame]
<!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 Mon Jan 27 16:42:29 PST 2020 -->
<title>ByteKeyRangeTracker (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<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.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":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&nbsp;Class</li>
<li><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/HasDefaultTracker.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&lt;<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>&gt;</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/Sizes.HasSize.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">Sizes.HasSize</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>&lt;<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>&gt;
implements <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/Sizes.HasSize.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">Sizes.HasSize</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">
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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">Called by the runner after <code>DoFn.ProcessElement</code> returns.</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>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html#getSize--">getSize</a></span>()</code>
<div class="block">A representation for the amount of known work represented as a size.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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>&nbsp;range)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<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>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<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>&nbsp;key)</code>
<div class="block">Attempts to claim the given key.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<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>&lt;<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>&gt;</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&nbsp;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&nbsp;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&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/ByteKeyRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">ByteKeyRangeTracker</a>&nbsp;of(<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>&nbsp;range)</pre>
</li>
</ul>
<a name="currentRestriction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentRestriction</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>&nbsp;currentRestriction()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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.</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>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;<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>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="trySplit-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trySplit</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/SplitResult.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">SplitResult</a>&lt;<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKeyRange.html" title="class in org.apache.beam.sdk.io.range">ByteKeyRange</a>&gt;&nbsp;trySplit(double&nbsp;fractionOfRemainder)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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 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>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;<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>&gt;</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>.</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&nbsp;boolean&nbsp;tryClaim(<a href="../../../../../../org/apache/beam/sdk/io/range/ByteKey.html" title="class in org.apache.beam.sdk.io.range">ByteKey</a>&nbsp;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>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;<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>&gt;</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&nbsp;void&nbsp;checkDone()
throws java.lang.IllegalStateException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html#checkDone--">RestrictionTracker</a></code></span></div>
<div class="block">Called by the runner 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.</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>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;<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>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getSize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;double&nbsp;getSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/Sizes.HasSize.html#getSize--">Sizes.HasSize</a></code></span></div>
<div class="block">A representation for the amount of known work represented as a size. Size <code>double</code>
representations should preferably represent a linear space.
<p>It is up to each restriction tracker to convert between their natural representation of
outstanding work and this representation. For example:
<ul>
<li>Block based file source (e.g. Avro): From the end of the current block, the remaining
number of bytes 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 not been processed.
<li>Key range based source (e.g. Shuffle, Bigtable, ...): Scale the start key to be one and
end key to be zero and interpolate the position of the next splittable key as the size.
If information about the probability density function or cumulative distribution
function is available, size 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
remaining bytes can be used.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/Sizes.HasSize.html#getSize--">getSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/Sizes.HasSize.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">Sizes.HasSize</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&nbsp;Class</li>
<li><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/HasDefaultTracker.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>