| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.12) on Wed Aug 18 10:34:26 PDT 2021 --> |
| <title>S3FileIO</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="S3FileIO"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":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"; |
| 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><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 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.aws.s3</a></div> |
| <h2 title="Class S3FileIO" class="title">Class S3FileIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.aws.s3.S3FileIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code>, <code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">S3FileIO</span> |
| extends java.lang.Object |
| implements <a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></pre> |
| <div class="block">FileIO implementation backed by S3. |
| <p> |
| Locations used must follow the conventions for S3 URIs (e.g. s3://bucket/path...). |
| URIs with schemes s3a, s3n, https are also treated as s3 file paths. |
| Using this FileIO with other schemes will result in <a href="../../exceptions/ValidationException.html" title="class in org.apache.iceberg.exceptions"><code>ValidationException</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.iceberg.aws.s3.S3FileIO">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">S3FileIO</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">No-arg constructor to load the FileIO dynamically.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.iceberg.util.SerializableSupplier)">S3FileIO</a></span>​(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a><software.amazon.awssdk.services.s3.S3Client> s3)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor with custom s3 supplier and default AWS properties.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.iceberg.util.SerializableSupplier,org.apache.iceberg.aws.AwsProperties)">S3FileIO</a></span>​(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a><software.amazon.awssdk.services.s3.S3Client> s3, |
| <a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a> awsProperties)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor with custom s3 supplier and AWS properties.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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"> </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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteFile(java.lang.String)">deleteFile</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the file at the given path.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.util.Map)">initialize</a></span>​(java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Initialize File IO from catalog properties.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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="#newInputFile(java.lang.String)">newInputFile</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a <a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> instance to read bytes from the file at the given path.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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="#newOutputFile(java.lang.String)">newOutputFile</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a <a href="../../io/OutputFile.html" title="interface in org.apache.iceberg.io"><code>OutputFile</code></a> instance to write bytes to the file at the given path.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.io.FileIO"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.io.<a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></h3> |
| <code><a href="../../io/FileIO.html#deleteFile(org.apache.iceberg.io.InputFile)">deleteFile</a>, <a href="../../io/FileIO.html#deleteFile(org.apache.iceberg.io.OutputFile)">deleteFile</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>S3FileIO</h4> |
| <pre>public S3FileIO()</pre> |
| <div class="block">No-arg constructor to load the FileIO dynamically. |
| <p> |
| All fields are initialized by calling <a href="#initialize(java.util.Map)"><code>initialize(Map)</code></a> later.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.iceberg.util.SerializableSupplier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>S3FileIO</h4> |
| <pre>public S3FileIO​(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a><software.amazon.awssdk.services.s3.S3Client> s3)</pre> |
| <div class="block">Constructor with custom s3 supplier and default AWS properties. |
| <p> |
| Calling <a href="#initialize(java.util.Map)"><code>initialize(Map)</code></a> will overwrite information set in this constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s3</code> - s3 supplier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.iceberg.util.SerializableSupplier,org.apache.iceberg.aws.AwsProperties)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>S3FileIO</h4> |
| <pre>public S3FileIO​(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a><software.amazon.awssdk.services.s3.S3Client> s3, |
| <a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a> awsProperties)</pre> |
| <div class="block">Constructor with custom s3 supplier and AWS properties. |
| <p> |
| Calling <a href="#initialize(java.util.Map)"><code>initialize(Map)</code></a> will overwrite information set in this constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s3</code> - s3 supplier</dd> |
| <dd><code>awsProperties</code> - aws properties</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="newInputFile(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInputFile</h4> |
| <pre class="methodSignature">public <a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a> newInputFile​(java.lang.String path)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../io/FileIO.html#newInputFile(java.lang.String)">FileIO</a></code></span></div> |
| <div class="block">Get a <a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> instance to read bytes from the file at the given path.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/FileIO.html#newInputFile(java.lang.String)">newInputFile</a></code> in interface <code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newOutputFile(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newOutputFile</h4> |
| <pre class="methodSignature">public <a href="../../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> newOutputFile​(java.lang.String path)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../io/FileIO.html#newOutputFile(java.lang.String)">FileIO</a></code></span></div> |
| <div class="block">Get a <a href="../../io/OutputFile.html" title="interface in org.apache.iceberg.io"><code>OutputFile</code></a> instance to write bytes to the file at the given path.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/FileIO.html#newOutputFile(java.lang.String)">newOutputFile</a></code> in interface <code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteFile(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteFile</h4> |
| <pre class="methodSignature">public void deleteFile​(java.lang.String path)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../io/FileIO.html#deleteFile(java.lang.String)">FileIO</a></code></span></div> |
| <div class="block">Delete the file at the given path.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/FileIO.html#deleteFile(java.lang.String)">deleteFile</a></code> in interface <code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="initialize(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">public void initialize​(java.util.Map<java.lang.String,​java.lang.String> properties)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../io/FileIO.html#initialize(java.util.Map)">FileIO</a></code></span></div> |
| <div class="block">Initialize File IO from catalog properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/FileIO.html#initialize(java.util.Map)">initialize</a></code> in interface <code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - catalog properties</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><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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
