blob: 5e9589b14fd4aa31cb21bb6f2298daccfcdd5fcc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.12) on Wed Aug 18 10:34:26 PDT 2021 -->
<title>HadoopOutputFile</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-08-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HadoopOutputFile";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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";
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&nbsp;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:&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.iceberg.hadoop</a></div>
<h2 title="Class HadoopOutputFile" class="title">Class HadoopOutputFile</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.hadoop.HadoopOutputFile</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">HadoopOutputFile</span>
extends java.lang.Object
implements <a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></pre>
<div class="block"><a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io"><code>OutputFile</code></a> implementation using the Hadoop <code>FileSystem</code> API.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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">&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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io">PositionOutputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create()">create</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new file and return a <a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io"><code>PositionOutputStream</code></a> to it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io">PositionOutputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createOrOverwrite()">createOrOverwrite</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new file and return a <a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io"><code>PositionOutputStream</code></a> to it.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromLocation(java.lang.CharSequence,org.apache.hadoop.conf.Configuration)">fromLocation</a></span>&#8203;(java.lang.CharSequence&nbsp;location,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromLocation(java.lang.CharSequence,org.apache.hadoop.fs.FileSystem)">fromLocation</a></span>&#8203;(java.lang.CharSequence&nbsp;location,
org.apache.hadoop.fs.FileSystem&nbsp;fs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromPath(org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)">fromPath</a></span>&#8203;(org.apache.hadoop.fs.Path&nbsp;path,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromPath(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem)">fromPath</a></span>&#8203;(org.apache.hadoop.fs.Path&nbsp;path,
org.apache.hadoop.fs.FileSystem&nbsp;fs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromPath(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.conf.Configuration)">fromPath</a></span>&#8203;(org.apache.hadoop.fs.Path&nbsp;path,
org.apache.hadoop.fs.FileSystem&nbsp;fs,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConf()">getConf</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.fs.FileSystem</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileSystem()">getFileSystem</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.fs.Path</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath()">getPath</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#location()">location</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the location this output file will create.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toInputFile()">toInputFile</a></span>()</code></th>
<td class="colLast">
<div class="block">Return an <a href="../io/InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> for the location of this output file.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="fromLocation(java.lang.CharSequence,org.apache.hadoop.conf.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromLocation</h4>
<pre class="methodSignature">public static&nbsp;<a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>&nbsp;fromLocation&#8203;(java.lang.CharSequence&nbsp;location,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
<a id="fromLocation(java.lang.CharSequence,org.apache.hadoop.fs.FileSystem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromLocation</h4>
<pre class="methodSignature">public static&nbsp;<a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>&nbsp;fromLocation&#8203;(java.lang.CharSequence&nbsp;location,
org.apache.hadoop.fs.FileSystem&nbsp;fs)</pre>
</li>
</ul>
<a id="fromPath(org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPath</h4>
<pre class="methodSignature">public static&nbsp;<a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>&nbsp;fromPath&#8203;(org.apache.hadoop.fs.Path&nbsp;path,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
<a id="fromPath(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPath</h4>
<pre class="methodSignature">public static&nbsp;<a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>&nbsp;fromPath&#8203;(org.apache.hadoop.fs.Path&nbsp;path,
org.apache.hadoop.fs.FileSystem&nbsp;fs)</pre>
</li>
</ul>
<a id="fromPath(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.conf.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPath</h4>
<pre class="methodSignature">public static&nbsp;<a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>&nbsp;fromPath&#8203;(org.apache.hadoop.fs.Path&nbsp;path,
org.apache.hadoop.fs.FileSystem&nbsp;fs,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
<a id="create()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public&nbsp;<a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io">PositionOutputStream</a>&nbsp;create()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../io/OutputFile.html#create()">OutputFile</a></code></span></div>
<div class="block">Create a new file and return a <a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io"><code>PositionOutputStream</code></a> to it.
<p>
If the file already exists, this will throw an exception.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/OutputFile.html#create()">create</a></code>&nbsp;in interface&nbsp;<code><a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an output stream that can report its position</dd>
</dl>
</li>
</ul>
<a id="createOrOverwrite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createOrOverwrite</h4>
<pre class="methodSignature">public&nbsp;<a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io">PositionOutputStream</a>&nbsp;createOrOverwrite()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../io/OutputFile.html#createOrOverwrite()">OutputFile</a></code></span></div>
<div class="block">Create a new file and return a <a href="../io/PositionOutputStream.html" title="class in org.apache.iceberg.io"><code>PositionOutputStream</code></a> to it.
<p>
If the file already exists, this will not throw an exception and will replace the file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/OutputFile.html#createOrOverwrite()">createOrOverwrite</a></code>&nbsp;in interface&nbsp;<code><a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an output stream that can report its position</dd>
</dl>
</li>
</ul>
<a id="getPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre class="methodSignature">public&nbsp;org.apache.hadoop.fs.Path&nbsp;getPath()</pre>
</li>
</ul>
<a id="getConf()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConf</h4>
<pre class="methodSignature">public&nbsp;org.apache.hadoop.conf.Configuration&nbsp;getConf()</pre>
</li>
</ul>
<a id="getFileSystem()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileSystem</h4>
<pre class="methodSignature">public&nbsp;org.apache.hadoop.fs.FileSystem&nbsp;getFileSystem()</pre>
</li>
</ul>
<a id="location()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>location</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;location()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../io/OutputFile.html#location()">OutputFile</a></code></span></div>
<div class="block">Return the location this output file will create.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/OutputFile.html#location()">location</a></code>&nbsp;in interface&nbsp;<code><a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the location of this output file</dd>
</dl>
</li>
</ul>
<a id="toInputFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toInputFile</h4>
<pre class="methodSignature">public&nbsp;<a href="../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a>&nbsp;toInputFile()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../io/OutputFile.html#toInputFile()">OutputFile</a></code></span></div>
<div class="block">Return an <a href="../io/InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> for the location of this output file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../io/OutputFile.html#toInputFile()">toInputFile</a></code>&nbsp;in interface&nbsp;<code><a href="../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an input file for the location of this output file</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">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>
</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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>