blob: fbf91199efc802ae103bf8650ede65ca30a5a38a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>S3InputFile</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.0.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="S3InputFile";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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.aws.s3</a></div>
<h2 title="Class S3InputFile" class="title">Class S3InputFile</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.aws.s3.S3InputFile</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../encryption/NativelyEncryptedFile.html" title="interface in org.apache.iceberg.encryption">NativelyEncryptedFile</a></code>, <code><a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">S3InputFile</span>
extends java.lang.Object
implements <a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a>, <a href="../../encryption/NativelyEncryptedFile.html" title="interface in org.apache.iceberg.encryption">NativelyEncryptedFile</a></pre>
</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">&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="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#awsProperties()">awsProperties</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exists()">exists</a></span>()</code></th>
<td class="colLast">
<div class="block">Note: this may be stale if file was deleted since metadata is cached for size/existence checks.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="S3InputFile.html" title="class in org.apache.iceberg.aws.s3">S3InputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromLocation(java.lang.String,long,software.amazon.awssdk.services.s3.S3Client,org.apache.iceberg.aws.AwsProperties,org.apache.iceberg.metrics.MetricsContext)">fromLocation</a></span>&#8203;(java.lang.String&nbsp;location,
long&nbsp;length,
software.amazon.awssdk.services.s3.S3Client&nbsp;client,
<a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a>&nbsp;awsProperties,
<a href="../../metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a>&nbsp;metrics)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="S3InputFile.html" title="class in org.apache.iceberg.aws.s3">S3InputFile</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromLocation(java.lang.String,software.amazon.awssdk.services.s3.S3Client,org.apache.iceberg.aws.AwsProperties,org.apache.iceberg.metrics.MetricsContext)">fromLocation</a></span>&#8203;(java.lang.String&nbsp;location,
software.amazon.awssdk.services.s3.S3Client&nbsp;client,
<a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a>&nbsp;awsProperties,
<a href="../../metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a>&nbsp;metrics)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLength()">getLength</a></span>()</code></th>
<td class="colLast">
<div class="block">Note: this may be stale if file was deleted since metadata is cached for size/existence checks.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected software.amazon.awssdk.services.s3.model.HeadObjectResponse</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectMetadata()">getObjectMetadata</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="#location()">location</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="../../metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metrics()">metrics</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../encryption/NativeFileCryptoParameters.html" title="class in org.apache.iceberg.encryption">NativeFileCryptoParameters</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nativeCryptoParameters()">nativeCryptoParameters</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../io/SeekableInputStream.html" title="class in org.apache.iceberg.io">SeekableInputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newStream()">newStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Opens a new <a href="../../io/SeekableInputStream.html" title="class in org.apache.iceberg.io"><code>SeekableInputStream</code></a> for the underlying data file</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNativeCryptoParameters(org.apache.iceberg.encryption.NativeFileCryptoParameters)">setNativeCryptoParameters</a></span>&#8203;(<a href="../../encryption/NativeFileCryptoParameters.html" title="class in org.apache.iceberg.encryption">NativeFileCryptoParameters</a>&nbsp;nativeCryptoParameters)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.io.InputFile">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.iceberg.io.<a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></h3>
<code><a href="../../io/InputFile.html#exists()">exists</a>, <a href="../../io/InputFile.html#location()">location</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="fromLocation(java.lang.String,software.amazon.awssdk.services.s3.S3Client,org.apache.iceberg.aws.AwsProperties,org.apache.iceberg.metrics.MetricsContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromLocation</h4>
<pre class="methodSignature">public static&nbsp;<a href="S3InputFile.html" title="class in org.apache.iceberg.aws.s3">S3InputFile</a>&nbsp;fromLocation&#8203;(java.lang.String&nbsp;location,
software.amazon.awssdk.services.s3.S3Client&nbsp;client,
<a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a>&nbsp;awsProperties,
<a href="../../metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a>&nbsp;metrics)</pre>
</li>
</ul>
<a id="fromLocation(java.lang.String,long,software.amazon.awssdk.services.s3.S3Client,org.apache.iceberg.aws.AwsProperties,org.apache.iceberg.metrics.MetricsContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromLocation</h4>
<pre class="methodSignature">public static&nbsp;<a href="S3InputFile.html" title="class in org.apache.iceberg.aws.s3">S3InputFile</a>&nbsp;fromLocation&#8203;(java.lang.String&nbsp;location,
long&nbsp;length,
software.amazon.awssdk.services.s3.S3Client&nbsp;client,
<a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a>&nbsp;awsProperties,
<a href="../../metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a>&nbsp;metrics)</pre>
</li>
</ul>
<a id="getLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLength</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getLength()</pre>
<div class="block">Note: this may be stale if file was deleted since metadata is cached for size/existence checks.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/InputFile.html#getLength()">getLength</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>content length</dd>
</dl>
</li>
</ul>
<a id="newStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newStream</h4>
<pre class="methodSignature">public&nbsp;<a href="../../io/SeekableInputStream.html" title="class in org.apache.iceberg.io">SeekableInputStream</a>&nbsp;newStream()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../io/InputFile.html#newStream()">InputFile</a></code></span></div>
<div class="block">Opens a new <a href="../../io/SeekableInputStream.html" title="class in org.apache.iceberg.io"><code>SeekableInputStream</code></a> for the underlying data file</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../io/InputFile.html#newStream()">newStream</a></code>&nbsp;in interface&nbsp;<code><a href="../../io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a seekable stream for reading the file</dd>
</dl>
</li>
</ul>
<a id="nativeCryptoParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nativeCryptoParameters</h4>
<pre class="methodSignature">public&nbsp;<a href="../../encryption/NativeFileCryptoParameters.html" title="class in org.apache.iceberg.encryption">NativeFileCryptoParameters</a>&nbsp;nativeCryptoParameters()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../encryption/NativelyEncryptedFile.html#nativeCryptoParameters()">nativeCryptoParameters</a></code>&nbsp;in interface&nbsp;<code><a href="../../encryption/NativelyEncryptedFile.html" title="interface in org.apache.iceberg.encryption">NativelyEncryptedFile</a></code></dd>
</dl>
</li>
</ul>
<a id="setNativeCryptoParameters(org.apache.iceberg.encryption.NativeFileCryptoParameters)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNativeCryptoParameters</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNativeCryptoParameters&#8203;(<a href="../../encryption/NativeFileCryptoParameters.html" title="class in org.apache.iceberg.encryption">NativeFileCryptoParameters</a>&nbsp;nativeCryptoParameters)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../encryption/NativelyEncryptedFile.html#setNativeCryptoParameters(org.apache.iceberg.encryption.NativeFileCryptoParameters)">setNativeCryptoParameters</a></code>&nbsp;in interface&nbsp;<code><a href="../../encryption/NativelyEncryptedFile.html" title="interface in org.apache.iceberg.encryption">NativelyEncryptedFile</a></code></dd>
</dl>
</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>
</li>
</ul>
<a id="awsProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awsProperties</h4>
<pre class="methodSignature">public&nbsp;<a href="../AwsProperties.html" title="class in org.apache.iceberg.aws">AwsProperties</a>&nbsp;awsProperties()</pre>
</li>
</ul>
<a id="metrics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metrics</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a>&nbsp;metrics()</pre>
</li>
</ul>
<a id="exists()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exists</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;exists()</pre>
<div class="block">Note: this may be stale if file was deleted since metadata is cached for size/existence checks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>flag</dd>
</dl>
</li>
</ul>
<a id="getObjectMetadata()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectMetadata</h4>
<pre class="methodSignature">protected&nbsp;software.amazon.awssdk.services.s3.model.HeadObjectResponse&nbsp;getObjectMetadata()
throws software.amazon.awssdk.services.s3.model.S3Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>software.amazon.awssdk.services.s3.model.S3Exception</code></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>