| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>FileScanTask</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../jquery/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FileScanTask"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":6,"i2":18,"i3":18,"i4":18,"i5":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.iceberg</a></div> |
| <h2 title="Interface FileScanTask" class="title">Interface FileScanTask</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ContentScanTask.html" title="interface in org.apache.iceberg">ContentScanTask</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code>, <code><a href="PartitionScanTask.html" title="interface in org.apache.iceberg">PartitionScanTask</a></code>, <code><a href="ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code>, <code>java.io.Serializable</code>, <code><a href="SplittableScanTask.html" title="interface in org.apache.iceberg">SplittableScanTask</a><<a href="FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="DataTask.html" title="interface in org.apache.iceberg">DataTask</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseFileScanTask.html" title="class in org.apache.iceberg">BaseFileScanTask</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">FileScanTask</span> |
| extends <a href="ContentScanTask.html" title="interface in org.apache.iceberg">ContentScanTask</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>>, <a href="SplittableScanTask.html" title="interface in org.apache.iceberg">SplittableScanTask</a><<a href="FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>></pre> |
| <div class="block">A scan task over a range of bytes in a single data file.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default <a href="FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asFileScanTask()">asFileScanTask</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns this cast to <a href="FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a> if it is one</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deletes()">deletes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">A list of <a href="DeleteFile.html" title="interface in org.apache.iceberg"><code>delete files</code></a> to apply when reading the task's data file.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filesCount()">filesCount</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The number of files that will be opened by this scan task.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFileScanTask()">isFileScanTask</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this is a <a href="FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a>, false otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default <a href="Schema.html" title="class in org.apache.iceberg">Schema</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#schema()">schema</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the schema for this file scan task.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sizeBytes()">sizeBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The number of bytes that should be read by this scan task.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.ContentScanTask"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="ContentScanTask.html" title="interface in org.apache.iceberg">ContentScanTask</a></h3> |
| <code><a href="ContentScanTask.html#estimatedRowsCount()">estimatedRowsCount</a>, <a href="ContentScanTask.html#file()">file</a>, <a href="ContentScanTask.html#length()">length</a>, <a href="ContentScanTask.html#partition()">partition</a>, <a href="ContentScanTask.html#residual()">residual</a>, <a href="ContentScanTask.html#start()">start</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.PartitionScanTask"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="PartitionScanTask.html" title="interface in org.apache.iceberg">PartitionScanTask</a></h3> |
| <code><a href="PartitionScanTask.html#spec()">spec</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.ScanTask"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></h3> |
| <code><a href="ScanTask.html#asCombinedScanTask()">asCombinedScanTask</a>, <a href="ScanTask.html#asDataTask()">asDataTask</a>, <a href="ScanTask.html#isDataTask()">isDataTask</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.SplittableScanTask"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="SplittableScanTask.html" title="interface in org.apache.iceberg">SplittableScanTask</a></h3> |
| <code><a href="SplittableScanTask.html#split(long)">split</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="deletes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletes</h4> |
| <pre class="methodSignature">java.util.List<<a href="DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a>> deletes()</pre> |
| <div class="block">A list of <a href="DeleteFile.html" title="interface in org.apache.iceberg"><code>delete files</code></a> to apply when reading the task's data file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of delete files to apply</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="schema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre class="methodSignature">default <a href="Schema.html" title="class in org.apache.iceberg">Schema</a> schema()</pre> |
| <div class="block">Return the schema for this file scan task.</div> |
| </li> |
| </ul> |
| <a id="sizeBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sizeBytes</h4> |
| <pre class="methodSignature">default long sizeBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ScanTask.html#sizeBytes()">ScanTask</a></code></span></div> |
| <div class="block">The number of bytes that should be read by this scan task.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ContentScanTask.html#sizeBytes()">sizeBytes</a></code> in interface <code><a href="ContentScanTask.html" title="interface in org.apache.iceberg">ContentScanTask</a><<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ScanTask.html#sizeBytes()">sizeBytes</a></code> in interface <code><a href="ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the total number of bytes to read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="filesCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filesCount</h4> |
| <pre class="methodSignature">default int filesCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ScanTask.html#filesCount()">ScanTask</a></code></span></div> |
| <div class="block">The number of files that will be opened by this scan task.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ScanTask.html#filesCount()">filesCount</a></code> in interface <code><a href="ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of files to open</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFileScanTask()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFileScanTask</h4> |
| <pre class="methodSignature">default boolean isFileScanTask()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ScanTask.html#isFileScanTask()">ScanTask</a></code></span></div> |
| <div class="block">Returns true if this is a <a href="FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a>, false otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ScanTask.html#isFileScanTask()">isFileScanTask</a></code> in interface <code><a href="ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="asFileScanTask()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>asFileScanTask</h4> |
| <pre class="methodSignature">default <a href="FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a> asFileScanTask()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ScanTask.html#asFileScanTask()">ScanTask</a></code></span></div> |
| <div class="block">Returns this cast to <a href="FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a> if it is one</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ScanTask.html#asFileScanTask()">asFileScanTask</a></code> in interface <code><a href="ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this cast to <a href="FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a> if it is one</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
