| <!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>ParquetIO.ReadFiles.BlockTracker (Apache Beam 2.38.0-SNAPSHOT)</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="ParquetIO.ReadFiles.BlockTracker (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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/io/parquet/ParquetIO.ReadFiles.html" title="class in org.apache.beam.sdk.io.parquet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/parquet/ParquetIO.Sink.html" title="class in org.apache.beam.sdk.io.parquet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/parquet/ParquetIO.ReadFiles.BlockTracker.html" target="_top">Frames</a></li> |
| <li><a href="ParquetIO.ReadFiles.BlockTracker.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.splittabledofn.OffsetRangeTracker">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.parquet</div> |
| <h2 title="Class ParquetIO.ReadFiles.BlockTracker" class="title">Class ParquetIO.ReadFiles.BlockTracker</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/OffsetRange.html" title="class in org.apache.beam.sdk.io.range">OffsetRange</a>,java.lang.Long></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">org.apache.beam.sdk.transforms.splittabledofn.OffsetRangeTracker</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.parquet.ParquetIO.ReadFiles.BlockTracker</li> |
| </ul> |
| </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> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/io/parquet/ParquetIO.ReadFiles.html" title="class in org.apache.beam.sdk.io.parquet">ParquetIO.ReadFiles</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">ParquetIO.ReadFiles.BlockTracker</span> |
| extends <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">OffsetRangeTracker</a></pre> |
| </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> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.splittabledofn.OffsetRangeTracker"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.sdk.transforms.splittabledofn.<a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">OffsetRangeTracker</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#lastAttemptedOffset">lastAttemptedOffset</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#lastClaimedOffset">lastClaimedOffset</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#range">range</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/parquet/ParquetIO.ReadFiles.BlockTracker.html#BlockTracker-org.apache.beam.sdk.io.range.OffsetRange-long-long-">BlockTracker</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRange.html" title="class in org.apache.beam.sdk.io.range">OffsetRange</a> range, |
| long totalByteSize, |
| long recordCount)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><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/io/parquet/ParquetIO.ReadFiles.BlockTracker.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="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/parquet/ParquetIO.ReadFiles.BlockTracker.html#makeProgress--">makeProgress</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.splittabledofn.OffsetRangeTracker"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.splittabledofn.<a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">OffsetRangeTracker</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#checkDone--">checkDone</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#currentRestriction--">currentRestriction</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#isBounded--">isBounded</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#toString--">toString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#tryClaim-java.lang.Long-">tryClaim</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#trySplit-double-">trySplit</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BlockTracker-org.apache.beam.sdk.io.range.OffsetRange-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BlockTracker</h4> |
| <pre>public BlockTracker(<a href="../../../../../../org/apache/beam/sdk/io/range/OffsetRange.html" title="class in org.apache.beam.sdk.io.range">OffsetRange</a> range, |
| long totalByteSize, |
| long recordCount)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="makeProgress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeProgress</h4> |
| <pre>public void makeProgress() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html#getProgress--">getProgress</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/splittabledofn/OffsetRangeTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">OffsetRangeTracker</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><a href="../../../../../../org/apache/beam/sdk/io/parquet/ParquetIO.ReadFiles.html" title="class in org.apache.beam.sdk.io.parquet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/parquet/ParquetIO.Sink.html" title="class in org.apache.beam.sdk.io.parquet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/parquet/ParquetIO.ReadFiles.BlockTracker.html" target="_top">Frames</a></li> |
| <li><a href="ParquetIO.ReadFiles.BlockTracker.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.splittabledofn.OffsetRangeTracker">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
