Google Git
Sign in
apache / iceberg / refs/heads/asf-site / . / javadoc / 1.5.0 / org / apache / iceberg / aws / s3 / S3FileIO.html
blob: 36431c8cd978283d8d146f5320185a6482522565 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>S3FileIO</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="S3FileIO";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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&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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.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.Closeable</code>, <code>java.io.Serializable</code>, <code>java.lang.AutoCloseable</code>, <code><a href="../../io/CredentialSupplier.html" title="interface in org.apache.iceberg.io">CredentialSupplier</a></code>, <code><a href="../../io/DelegateFileIO.html" title="interface in org.apache.iceberg.io">DelegateFileIO</a></code>, <code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code>, <code><a href="../../io/SupportsBulkOperations.html" title="interface in org.apache.iceberg.io">SupportsBulkOperations</a></code>, <code><a href="../../io/SupportsPrefixOperations.html" title="interface in org.apache.iceberg.io">SupportsPrefixOperations</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">S3FileIO</span>
extends java.lang.Object
implements <a href="../../io/CredentialSupplier.html" title="interface in org.apache.iceberg.io">CredentialSupplier</a>, <a href="../../io/DelegateFileIO.html" title="interface in org.apache.iceberg.io">DelegateFileIO</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>
<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">&nbsp;</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>&#8203;(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a>&lt;software.amazon.awssdk.services.s3.S3Client&gt;&nbsp;s3)</code></th>
<td class="colLast">
<div class="block">Constructor with custom s3 supplier and S3FileIO 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.s3.S3FileIOProperties)">S3FileIO</a></span>&#8203;(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a>&lt;software.amazon.awssdk.services.s3.S3Client&gt;&nbsp;s3,
<a href="S3FileIOProperties.html" title="class in org.apache.iceberg.aws.s3">S3FileIOProperties</a>&nbsp;s3FileIOProperties)</code></th>
<td class="colLast">
<div class="block">Constructor with custom s3 supplier and S3FileIO properties.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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">&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>software.amazon.awssdk.services.s3.S3Client</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client()">client</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Close File IO to release underlying resources.</div>
</td>
</tr>
<tr id="i2" 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>&#8203;(java.lang.String&nbsp;path)</code></th>
<td class="colLast">
<div class="block">Delete the file at the given path.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteFiles(java.lang.Iterable)">deleteFiles</a></span>&#8203;(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;paths)</code></th>
<td class="colLast">
<div class="block">Deletes the given paths in a batched manner.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deletePrefix(java.lang.String)">deletePrefix</a></span>&#8203;(java.lang.String&nbsp;prefix)</code></th>
<td class="colLast">
<div class="block">This method provides a "best-effort" to delete all objects under the given prefix.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finalize()">finalize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCredential()">getCredential</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the credential string</div>
</td>
</tr>
<tr id="i7" 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>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;props)</code></th>
<td class="colLast">
<div class="block">Initialize File IO from catalog properties.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.Iterable&lt;<a href="../../io/FileInfo.html" title="class in org.apache.iceberg.io">FileInfo</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listPrefix(java.lang.String)">listPrefix</a></span>&#8203;(java.lang.String&nbsp;prefix)</code></th>
<td class="colLast">
<div class="block">Return an iterable of all files under a prefix.</div>
</td>
</tr>
<tr id="i9" 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="#newInputFile(java.lang.String)">newInputFile</a></span>&#8203;(java.lang.String&nbsp;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="i10" 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,long)">newInputFile</a></span>&#8203;(java.lang.String&nbsp;path,
long&nbsp;length)</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, with a known
file length.</div>
</td>
</tr>
<tr id="i11" 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>&#8203;(java.lang.String&nbsp;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>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the property map used to configure this FileIO</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&nbsp;java.lang.Object</h3>
<code>clone, equals, 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&nbsp;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>, <a href="../../io/FileIO.html#newInputFile(org.apache.iceberg.DataFile)">newInputFile</a>, <a href="../../io/FileIO.html#newInputFile(org.apache.iceberg.DeleteFile)">newInputFile</a>, <a href="../../io/FileIO.html#newInputFile(org.apache.iceberg.ManifestFile)">newInputFile</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>S3FileIO</h4>
<pre>public&nbsp;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="&lt;init&gt;(org.apache.iceberg.util.SerializableSupplier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>S3FileIO</h4>
<pre>public&nbsp;S3FileIO&#8203;(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a>&lt;software.amazon.awssdk.services.s3.S3Client&gt;&nbsp;s3)</pre>
<div class="block">Constructor with custom s3 supplier and S3FileIO 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="&lt;init&gt;(org.apache.iceberg.util.SerializableSupplier,org.apache.iceberg.aws.s3.S3FileIOProperties)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>S3FileIO</h4>
<pre>public&nbsp;S3FileIO&#8203;(<a href="../../util/SerializableSupplier.html" title="interface in org.apache.iceberg.util">SerializableSupplier</a>&lt;software.amazon.awssdk.services.s3.S3Client&gt;&nbsp;s3,
<a href="S3FileIOProperties.html" title="class in org.apache.iceberg.aws.s3">S3FileIOProperties</a>&nbsp;s3FileIOProperties)</pre>
<div class="block">Constructor with custom s3 supplier and S3FileIO 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>s3FileIOProperties</code> - S3 FileIO properties</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<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&nbsp;<a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a>&nbsp;newInputFile&#8203;(java.lang.String&nbsp;path)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd>
</dl>
</li>
</ul>
<a id="newInputFile(java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInputFile</h4>
<pre class="methodSignature">public&nbsp;<a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a>&nbsp;newInputFile&#8203;(java.lang.String&nbsp;path,
long&nbsp;length)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../io/FileIO.html#newInputFile(java.lang.String,long)">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, with a known
file length.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/FileIO.html#newInputFile(java.lang.String,long)">newInputFile</a></code>&nbsp;in interface&nbsp;<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&nbsp;<a href="../../io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>&nbsp;newOutputFile&#8203;(java.lang.String&nbsp;path)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;deleteFile&#8203;(java.lang.String&nbsp;path)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd>
</dl>
</li>
</ul>
<a id="properties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../io/FileIO.html#properties()">FileIO</a></code></span></div>
<div class="block">Returns the property map used to configure this FileIO</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/FileIO.html#properties()">properties</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd>
</dl>
</li>
</ul>
<a id="deleteFiles(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteFiles</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deleteFiles&#8203;(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;paths)
throws <a href="../../io/BulkDeletionFailureException.html" title="class in org.apache.iceberg.io">BulkDeletionFailureException</a></pre>
<div class="block">Deletes the given paths in a batched manner.
<p>The paths are grouped by bucket, and deletion is triggered when we either reach the
configured batch size or have a final remainder batch for each bucket.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/SupportsBulkOperations.html#deleteFiles(java.lang.Iterable)">deleteFiles</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/SupportsBulkOperations.html" title="interface in org.apache.iceberg.io">SupportsBulkOperations</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paths</code> - paths to delete</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../io/BulkDeletionFailureException.html" title="class in org.apache.iceberg.io">BulkDeletionFailureException</a></code> - in case of failure to delete at least 1 file</dd>
</dl>
</li>
</ul>
<a id="listPrefix(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listPrefix</h4>
<pre class="methodSignature">public&nbsp;java.lang.Iterable&lt;<a href="../../io/FileInfo.html" title="class in org.apache.iceberg.io">FileInfo</a>&gt;&nbsp;listPrefix&#8203;(java.lang.String&nbsp;prefix)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../io/SupportsPrefixOperations.html#listPrefix(java.lang.String)">SupportsPrefixOperations</a></code></span></div>
<div class="block">Return an iterable of all files under a prefix.
<p>Hierarchical file systems (e.g. HDFS) may impose additional restrictions like the prefix
must fully match a directory whereas key/value object stores may allow for arbitrary prefixes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/SupportsPrefixOperations.html#listPrefix(java.lang.String)">listPrefix</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/SupportsPrefixOperations.html" title="interface in org.apache.iceberg.io">SupportsPrefixOperations</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - prefix to list</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>iterable of file information</dd>
</dl>
</li>
</ul>
<a id="deletePrefix(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePrefix</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deletePrefix&#8203;(java.lang.String&nbsp;prefix)</pre>
<div class="block">This method provides a "best-effort" to delete all objects under the given prefix.
<p>Bulk delete operations are used and no reattempt is made for deletes if they fail, but will
log any individual objects that are not deleted as part of the bulk operation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/SupportsPrefixOperations.html#deletePrefix(java.lang.String)">deletePrefix</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/SupportsPrefixOperations.html" title="interface in org.apache.iceberg.io">SupportsPrefixOperations</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - prefix to delete</dd>
</dl>
</li>
</ul>
<a id="client()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>client</h4>
<pre class="methodSignature">public&nbsp;software.amazon.awssdk.services.s3.S3Client&nbsp;client()</pre>
</li>
</ul>
<a id="getCredential()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredential</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getCredential()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../io/CredentialSupplier.html#getCredential()">CredentialSupplier</a></code></span></div>
<div class="block">Returns the credential string</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/CredentialSupplier.html#getCredential()">getCredential</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/CredentialSupplier.html" title="interface in org.apache.iceberg.io">CredentialSupplier</a></code></dd>
</dl>
</li>
</ul>
<a id="initialize(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initialize&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;props)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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>props</code> - catalog properties</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../io/FileIO.html#close()">FileIO</a></code></span></div>
<div class="block">Close File IO to release underlying resources.
<p>Calling this method is only required when this FileIO instance is no longer expected to be
used, and the resources it holds need to be explicitly released to avoid resource leaks.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/FileIO.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></dd>
</dl>
</li>
</ul>
<a id="finalize()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalize</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;finalize()
throws java.lang.Throwable</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Throwable</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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>