mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-08-18 16:02:10 +00:00
Ruben Fiszel
82 lines
51 KiB
HTML
82 lines
51 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HelpersService | windmill-client</title><meta name="description" content="Documentation for windmill-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">windmill-client</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">windmill-client</a></li><li><a href="HelpersService.html">HelpersService</a></li></ul><h1>Class HelpersService</h1></div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6291</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="HelpersService.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="HelpersService.html#datasetStorageTestConnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dataset<wbr/>Storage<wbr/>Test<wbr/>Connection</span></a>
|
|
<a href="HelpersService.html#deleteS3File" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>S3<wbr/>File</span></a>
|
|
<a href="HelpersService.html#duckdbConnectionSettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>duckdb<wbr/>Connection<wbr/>Settings</span></a>
|
|
<a href="HelpersService.html#duckdbConnectionSettingsV2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>duckdb<wbr/>Connection<wbr/>Settings<wbr/>V2</span></a>
|
|
<a href="HelpersService.html#fileDownload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>file<wbr/>Download</span></a>
|
|
<a href="HelpersService.html#fileDownloadParquetAsCsv" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>file<wbr/>Download<wbr/>Parquet<wbr/>As<wbr/>Csv</span></a>
|
|
<a href="HelpersService.html#fileUpload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>file<wbr/>Upload</span></a>
|
|
<a href="HelpersService.html#listStoredFiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Stored<wbr/>Files</span></a>
|
|
<a href="HelpersService.html#loadCsvPreview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Csv<wbr/>Preview</span></a>
|
|
<a href="HelpersService.html#loadFileMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>File<wbr/>Metadata</span></a>
|
|
<a href="HelpersService.html#loadFilePreview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>File<wbr/>Preview</span></a>
|
|
<a href="HelpersService.html#loadParquetPreview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Parquet<wbr/>Preview</span></a>
|
|
<a href="HelpersService.html#moveS3File" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>S3<wbr/>File</span></a>
|
|
<a href="HelpersService.html#polarsConnectionSettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>polars<wbr/>Connection<wbr/>Settings</span></a>
|
|
<a href="HelpersService.html#polarsConnectionSettingsV2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>polars<wbr/>Connection<wbr/>Settings<wbr/>V2</span></a>
|
|
<a href="HelpersService.html#s3ResourceInfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>s3<wbr/>Resource<wbr/>Info</span></a>
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_HelpersService" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Helpers<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="HelpersService.html" class="tsd-signature-type tsd-kind-class">HelpersService</a><a href="#constructor.new_HelpersService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="HelpersService.html" class="tsd-signature-type tsd-kind-class">HelpersService</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="datasetStorageTestConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>dataset<wbr/>Storage<wbr/>Test<wbr/>Connection</span><a href="#datasetStorageTestConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="datasetStorageTestConnection.datasetStorageTestConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dataset<wbr/>Storage<wbr/>Test<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#datasetStorageTestConnection.datasetStorageTestConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Test connection to the workspace object storage</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DatasetStorageTestConnectionData.html" class="tsd-signature-type tsd-kind-type-alias">DatasetStorageTestConnectionData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown Connection settings</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6400</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteS3File" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>delete<wbr/>S3<wbr/>File</span><a href="#deleteS3File" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteS3File.deleteS3File-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>S3<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#deleteS3File.deleteS3File-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Permanently delete file from S3</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DeleteS3FileData.html" class="tsd-signature-type tsd-kind-type-alias">DeleteS3FileData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown Confirmation</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6577</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="duckdbConnectionSettings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>duckdb<wbr/>Connection<wbr/>Settings</span><a href="#duckdbConnectionSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="duckdbConnectionSettings.duckdbConnectionSettings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">duckdb<wbr/>Connection<wbr/>Settings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/DuckdbConnectionSettingsResponse.html" class="tsd-signature-type tsd-kind-type-alias">DuckdbConnectionSettingsResponse</a><span class="tsd-signature-symbol">></span><a href="#duckdbConnectionSettings.duckdbConnectionSettings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DuckdbConnectionSettingsData.html" class="tsd-signature-type tsd-kind-type-alias">DuckdbConnectionSettingsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/DuckdbConnectionSettingsResponse.html" class="tsd-signature-type tsd-kind-type-alias">DuckdbConnectionSettingsResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown Connection settings</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6300</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="duckdbConnectionSettingsV2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>duckdb<wbr/>Connection<wbr/>Settings<wbr/>V2</span><a href="#duckdbConnectionSettingsV2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="duckdbConnectionSettingsV2.duckdbConnectionSettingsV2-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">duckdb<wbr/>Connection<wbr/>Settings<wbr/>V2</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/DuckdbConnectionSettingsV2Response.html" class="tsd-signature-type tsd-kind-type-alias">DuckdbConnectionSettingsV2Response</a><span class="tsd-signature-symbol">></span><a href="#duckdbConnectionSettingsV2.duckdbConnectionSettingsV2-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DuckdbConnectionSettingsV2Data.html" class="tsd-signature-type tsd-kind-type-alias">DuckdbConnectionSettingsV2Data</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/DuckdbConnectionSettingsV2Response.html" class="tsd-signature-type tsd-kind-type-alias">DuckdbConnectionSettingsV2Response</a><span class="tsd-signature-symbol">></span></h4><p>unknown Connection settings</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6320</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fileDownload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>file<wbr/>Download</span><a href="#fileDownload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fileDownload.fileDownload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">file<wbr/>Download</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/FileDownloadResponse.html" class="tsd-signature-type tsd-kind-type-alias">FileDownloadResponse</a><span class="tsd-signature-symbol">></span><a href="#fileDownload.fileDownload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Download file to S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/FileDownloadData.html" class="tsd-signature-type tsd-kind-type-alias">FileDownloadData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/FileDownloadResponse.html" class="tsd-signature-type tsd-kind-type-alias">FileDownloadResponse</a><span class="tsd-signature-symbol">></span></h4><p>binary Chunk of the downloaded file</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6659</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fileDownloadParquetAsCsv" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>file<wbr/>Download<wbr/>Parquet<wbr/>As<wbr/>Csv</span><a href="#fileDownloadParquetAsCsv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fileDownloadParquetAsCsv.fileDownloadParquetAsCsv-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">file<wbr/>Download<wbr/>Parquet<wbr/>As<wbr/>Csv</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#fileDownloadParquetAsCsv.fileDownloadParquetAsCsv-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Download file to S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/FileDownloadParquetAsCsvData.html" class="tsd-signature-type tsd-kind-type-alias">FileDownloadParquetAsCsvData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string The downloaded file</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6685</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fileUpload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>file<wbr/>Upload</span><a href="#fileUpload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fileUpload.fileUpload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">file<wbr/>Upload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/FileUploadResponse.html" class="tsd-signature-type tsd-kind-type-alias">FileUploadResponse</a><span class="tsd-signature-symbol">></span><a href="#fileUpload.fileUpload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Upload file to S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/FileUploadData.html" class="tsd-signature-type tsd-kind-type-alias">FileUploadData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/FileUploadResponse.html" class="tsd-signature-type tsd-kind-type-alias">FileUploadResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown File upload status</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6629</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listStoredFiles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Stored<wbr/>Files</span><a href="#listStoredFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listStoredFiles.listStoredFiles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Stored<wbr/>Files</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListStoredFilesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListStoredFilesResponse</a><span class="tsd-signature-symbol">></span><a href="#listStoredFiles.listStoredFiles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>List the file keys available in a workspace object storage</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListStoredFilesData.html" class="tsd-signature-type tsd-kind-type-alias">ListStoredFilesData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListStoredFilesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListStoredFilesResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown List of file keys</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6424</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadCsvPreview" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>Csv<wbr/>Preview</span><a href="#loadCsvPreview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadCsvPreview.loadCsvPreview-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Csv<wbr/>Preview</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#loadCsvPreview.loadCsvPreview-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load a preview of a csv file</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/LoadCsvPreviewData.html" class="tsd-signature-type tsd-kind-type-alias">LoadCsvPreviewData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown Csv Preview</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6548</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadFileMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>File<wbr/>Metadata</span><a href="#loadFileMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadFileMetadata.loadFileMetadata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>File<wbr/>Metadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/WindmillFileMetadata.html" class="tsd-signature-type tsd-kind-type-alias">WindmillFileMetadata</a><span class="tsd-signature-symbol">></span><a href="#loadFileMetadata.loadFileMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load metadata of the file</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/LoadFileMetadataData.html" class="tsd-signature-type tsd-kind-type-alias">LoadFileMetadataData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/WindmillFileMetadata.html" class="tsd-signature-type tsd-kind-type-alias">WindmillFileMetadata</a><span class="tsd-signature-symbol">></span></h4><p>WindmillFileMetadata FileMetadata</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6449</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadFilePreview" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>File<wbr/>Preview</span><a href="#loadFilePreview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadFilePreview.loadFilePreview-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>File<wbr/>Preview</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/WindmillFilePreview.html" class="tsd-signature-type tsd-kind-type-alias">WindmillFilePreview</a><span class="tsd-signature-symbol">></span><a href="#loadFilePreview.loadFilePreview-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load a preview of the file</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/LoadFilePreviewData.html" class="tsd-signature-type tsd-kind-type-alias">LoadFilePreviewData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/WindmillFilePreview.html" class="tsd-signature-type tsd-kind-type-alias">WindmillFilePreview</a><span class="tsd-signature-symbol">></span></h4><p>WindmillFilePreview FilePreview</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6478</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadParquetPreview" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>load<wbr/>Parquet<wbr/>Preview</span><a href="#loadParquetPreview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loadParquetPreview.loadParquetPreview-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Parquet<wbr/>Preview</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#loadParquetPreview.loadParquetPreview-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load a preview of a parquet file</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/LoadParquetPreviewData.html" class="tsd-signature-type tsd-kind-type-alias">LoadParquetPreviewData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown Parquet Preview</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6513</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="moveS3File" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>move<wbr/>S3<wbr/>File</span><a href="#moveS3File" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="moveS3File.moveS3File-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">move<wbr/>S3<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#moveS3File.moveS3File-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Move a S3 file from one path to the other within the same bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/MoveS3FileData.html" class="tsd-signature-type tsd-kind-type-alias">MoveS3FileData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown Confirmation</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6601</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="polarsConnectionSettings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>polars<wbr/>Connection<wbr/>Settings</span><a href="#polarsConnectionSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="polarsConnectionSettings.polarsConnectionSettings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">polars<wbr/>Connection<wbr/>Settings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/PolarsConnectionSettingsResponse.html" class="tsd-signature-type tsd-kind-type-alias">PolarsConnectionSettingsResponse</a><span class="tsd-signature-symbol">></span><a href="#polarsConnectionSettings.polarsConnectionSettings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/PolarsConnectionSettingsData.html" class="tsd-signature-type tsd-kind-type-alias">PolarsConnectionSettingsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/PolarsConnectionSettingsResponse.html" class="tsd-signature-type tsd-kind-type-alias">PolarsConnectionSettingsResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown Connection settings</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6340</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="polarsConnectionSettingsV2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>polars<wbr/>Connection<wbr/>Settings<wbr/>V2</span><a href="#polarsConnectionSettingsV2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="polarsConnectionSettingsV2.polarsConnectionSettingsV2-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">polars<wbr/>Connection<wbr/>Settings<wbr/>V2</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/PolarsConnectionSettingsV2Response.html" class="tsd-signature-type tsd-kind-type-alias">PolarsConnectionSettingsV2Response</a><span class="tsd-signature-symbol">></span><a href="#polarsConnectionSettingsV2.polarsConnectionSettingsV2-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/PolarsConnectionSettingsV2Data.html" class="tsd-signature-type tsd-kind-type-alias">PolarsConnectionSettingsV2Data</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/PolarsConnectionSettingsV2Response.html" class="tsd-signature-type tsd-kind-type-alias">PolarsConnectionSettingsV2Response</a><span class="tsd-signature-symbol">></span></h4><p>unknown Connection settings</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6360</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="s3ResourceInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>s3<wbr/>Resource<wbr/>Info</span><a href="#s3ResourceInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="s3ResourceInfo.s3ResourceInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">s3<wbr/>Resource<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/S3Resource.html" class="tsd-signature-type tsd-kind-type-alias">S3Resource</a><span class="tsd-signature-symbol">></span><a href="#s3ResourceInfo.s3ResourceInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the s3 resource associated to the provided path, or the workspace default S3 resource</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/S3ResourceInfoData.html" class="tsd-signature-type tsd-kind-type-alias">S3ResourceInfoData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/S3Resource.html" class="tsd-signature-type tsd-kind-type-alias">S3Resource</a><span class="tsd-signature-symbol">></span></h4><p>S3Resource Connection settings</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:6380</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#datasetStorageTestConnection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dataset<wbr/>Storage<wbr/>Test<wbr/>Connection</span></a><a href="#deleteS3File" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>S3<wbr/>File</span></a><a href="#duckdbConnectionSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>duckdb<wbr/>Connection<wbr/>Settings</span></a><a href="#duckdbConnectionSettingsV2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>duckdb<wbr/>Connection<wbr/>Settings<wbr/>V2</span></a><a href="#fileDownload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>file<wbr/>Download</span></a><a href="#fileDownloadParquetAsCsv" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>file<wbr/>Download<wbr/>Parquet<wbr/>As<wbr/>Csv</span></a><a href="#fileUpload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>file<wbr/>Upload</span></a><a href="#listStoredFiles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Stored<wbr/>Files</span></a><a href="#loadCsvPreview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Csv<wbr/>Preview</span></a><a href="#loadFileMetadata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>File<wbr/>Metadata</span></a><a href="#loadFilePreview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>File<wbr/>Preview</span></a><a href="#loadParquetPreview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Parquet<wbr/>Preview</span></a><a href="#moveS3File" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>S3<wbr/>File</span></a><a href="#polarsConnectionSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>polars<wbr/>Connection<wbr/>Settings</span></a><a href="#polarsConnectionSettingsV2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>polars<wbr/>Connection<wbr/>Settings<wbr/>V2</span></a><a href="#s3ResourceInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>s3<wbr/>Resource<wbr/>Info</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>windmill-client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |