| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (17) on Sat Jun 13 20:43:56 UTC 2026 --> |
| <title>ObjectStoreOptions (Apache DataFusion Java 0.2.0-SNAPSHOT)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2026-06-13"> |
| <meta name="description" content="declaration: package: org.apache.datafusion, class: ObjectStoreOptions"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../script-dir/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="../../../script-dir/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ObjectStoreOptions.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.datafusion</a></div> |
| <h1 title="Class ObjectStoreOptions" class="title">Class ObjectStoreOptions</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.datafusion.ObjectStoreOptions</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ObjectStoreOptions.Gcs.html" title="class in org.apache.datafusion">ObjectStoreOptions.Gcs</a></code>, <code><a href="ObjectStoreOptions.Http.html" title="class in org.apache.datafusion">ObjectStoreOptions.Http</a></code>, <code><a href="ObjectStoreOptions.S3.html" title="class in org.apache.datafusion">ObjectStoreOptions.S3</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract sealed class </span><span class="element-name type-name-label">ObjectStoreOptions</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> |
| <span class="permits">permits <a href="ObjectStoreOptions.S3.html" title="class in org.apache.datafusion">ObjectStoreOptions.S3</a>, <a href="ObjectStoreOptions.Gcs.html" title="class in org.apache.datafusion">ObjectStoreOptions.Gcs</a>, <a href="ObjectStoreOptions.Http.html" title="class in org.apache.datafusion">ObjectStoreOptions.Http</a></span></div> |
| <div class="block">Description of an <code>object_store::ObjectStore</code> backend to register on a <a href="SessionContext.html" title="class in org.apache.datafusion"><code>SessionContext</code></a>'s <code>RuntimeEnv</code>. Pass instances to <a href="SessionContextBuilder.html#registerObjectStore(org.apache.datafusion.ObjectStoreOptions)"><code>SessionContextBuilder.registerObjectStore(ObjectStoreOptions)</code></a>. |
| |
| <p>Build instances via the per-backend factories: <a href="#s3()"><code>s3()</code></a>, <a href="#gcs()"><code>gcs()</code></a>, <a href="#http(java.lang.String)"><code>http(String)</code></a>. Each factory returns a builder whose <code>build()</code> produces an immutable <code> |
| ObjectStoreOptions</code> you can register. |
| |
| <p>For the cloud backends (S3 / GCS), the standard SDK environment variables are read as the |
| default <em>floor</em> (e.g. <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_DEFAULT_REGION</code>, ECS / |
| web-identity vars; <code>GOOGLE_APPLICATION_CREDENTIALS</code>). Explicit setters on the per-backend |
| builder always override those env values, so a JVM running on a credentialed host (IAM role, ECS |
| task, GKE workload identity) can register an empty-credentials store and let the SDK's default |
| chain do its job. |
| |
| <p>The URL DataFusion uses to look up the store is either an explicit <code>url(...)</code> on the |
| builder or, if unset, derived from the typed fields: |
| |
| <ul> |
| <li>S3 → <code>s3://<bucket></code> |
| <li>GCS → <code>gs://<bucket></code> |
| <li>HTTP → no scheme-default; <a href="#http(java.lang.String)"><code>http(String)</code></a> requires the URL up front. The URL must be |
| a host root (<code>https://example.com/</code> or <code>https://example.com</code>); paths cause |
| lookup-vs-base-URL collisions in DataFusion's registry. Register one HTTP store per |
| scheme+host and let SQL paths carry the rest. |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="ObjectStoreOptions.Gcs.html" class="type-name-link" title="class in org.apache.datafusion">ObjectStoreOptions.Gcs</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Google Cloud Storage.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ObjectStoreOptions.Http.html" class="type-name-link" title="class in org.apache.datafusion">ObjectStoreOptions.Http</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Listing-capable HTTP / WebDAV store.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="ObjectStoreOptions.S3.html" class="type-name-link" title="class in org.apache.datafusion">ObjectStoreOptions.S3</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Amazon S3 (and any S3-compatible endpoint such as MinIO, Cloudflare R2, Wasabi).</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ObjectStoreOptions.Gcs.Builder.html" title="class in org.apache.datafusion">ObjectStoreOptions.Gcs.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#gcs()" class="member-name-link">gcs</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Begin building a <a href="ObjectStoreOptions.Gcs.html" title="class in org.apache.datafusion"><code>ObjectStoreOptions.Gcs</code></a> (Google Cloud Storage) registration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ObjectStoreOptions.Http.Builder.html" title="class in org.apache.datafusion">ObjectStoreOptions.Http.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#http(java.lang.String)" class="member-name-link">http</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> listingUrl)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Begin building an <a href="ObjectStoreOptions.Http.html" title="class in org.apache.datafusion"><code>ObjectStoreOptions.Http</code></a> (listing-capable HTTP/WebDAV) registration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ObjectStoreOptions.S3.Builder.html" title="class in org.apache.datafusion">ObjectStoreOptions.S3.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#s3()" class="member-name-link">s3</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Begin building an <a href="ObjectStoreOptions.S3.html" title="class in org.apache.datafusion"><code>ObjectStoreOptions.S3</code></a> (also covers MinIO, R2, any S3-compatible) registration.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="s3()"> |
| <h3>s3</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ObjectStoreOptions.S3.Builder.html" title="class in org.apache.datafusion">ObjectStoreOptions.S3.Builder</a></span> <span class="element-name">s3</span>()</div> |
| <div class="block">Begin building an <a href="ObjectStoreOptions.S3.html" title="class in org.apache.datafusion"><code>ObjectStoreOptions.S3</code></a> (also covers MinIO, R2, any S3-compatible) registration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="gcs()"> |
| <h3>gcs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ObjectStoreOptions.Gcs.Builder.html" title="class in org.apache.datafusion">ObjectStoreOptions.Gcs.Builder</a></span> <span class="element-name">gcs</span>()</div> |
| <div class="block">Begin building a <a href="ObjectStoreOptions.Gcs.html" title="class in org.apache.datafusion"><code>ObjectStoreOptions.Gcs</code></a> (Google Cloud Storage) registration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="http(java.lang.String)"> |
| <h3>http</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ObjectStoreOptions.Http.Builder.html" title="class in org.apache.datafusion">ObjectStoreOptions.Http.Builder</a></span> <span class="element-name">http</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> listingUrl)</span></div> |
| <div class="block">Begin building an <a href="ObjectStoreOptions.Http.html" title="class in org.apache.datafusion"><code>ObjectStoreOptions.Http</code></a> (listing-capable HTTP/WebDAV) registration. The listing-root URL |
| is required because no sensible default exists.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>listingUrl</code> is <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2026. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
