| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg/arrow/s3/s3_properties.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_f4d027612078328dc1681a60f28d52c0.html">arrow</a></li><li class="navelem"><a class="el" href="dir_85b5e99aabb5070677168e5f60ecad95.html">s3</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">s3_properties.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span>iceberg::arrow {</div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="foldopen" id="foldopen00031" data-start="{" data-end="};"> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html"> 31</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1arrow_1_1S3Properties.html">S3Properties</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a30e6db54fade15dc71a3d96acb4b2cf2"> 33</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a30e6db54fade15dc71a3d96acb4b2cf2">kS3Schema</a> = <span class="stringliteral">"s3"</span>;</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a74b91b99b163d51c58a402d0f83455d6"> 35</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a74b91b99b163d51c58a402d0f83455d6">kAccessKeyId</a> = <span class="stringliteral">"s3.access-key-id"</span>;</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a14889abe7efdfb7be4fc0d6f2ecaade9"> 37</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a14889abe7efdfb7be4fc0d6f2ecaade9">kSecretAccessKey</a> = <span class="stringliteral">"s3.secret-access-key"</span>;</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a4dec61230ee68d2b9bbcf8dbc999c6c8"> 39</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a4dec61230ee68d2b9bbcf8dbc999c6c8">kSessionToken</a> = <span class="stringliteral">"s3.session-token"</span>;</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a65574ce4f661cbc8d8a411c1c6a35e31"> 41</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a65574ce4f661cbc8d8a411c1c6a35e31">kRegion</a> = <span class="stringliteral">"s3.region"</span>;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a99156e6180c4a40fc23504f01c59ee40"> 43</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a99156e6180c4a40fc23504f01c59ee40">kEndpoint</a> = <span class="stringliteral">"s3.endpoint"</span>;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a66135f09349d2c6d3babb892a0f2d28b"> 45</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a66135f09349d2c6d3babb892a0f2d28b">kPathStyleAccess</a> = <span class="stringliteral">"s3.path-style-access"</span>;</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#ab54266a1acc0977d8ed9bf83fe54e223"> 47</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#ab54266a1acc0977d8ed9bf83fe54e223">kSslEnabled</a> = <span class="stringliteral">"s3.ssl.enabled"</span>;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a80f30f9b8a5d743a59b7a5b9c56e9b5d"> 49</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a80f30f9b8a5d743a59b7a5b9c56e9b5d">kConnectTimeoutMs</a> = <span class="stringliteral">"s3.connect-timeout-ms"</span>;</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structiceberg_1_1arrow_1_1S3Properties.html#a3b0bc87f9ac7c4e3fbb0ada424742a8f"> 51</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1arrow_1_1S3Properties.html#a3b0bc87f9ac7c4e3fbb0ada424742a8f">kSocketTimeoutMs</a> = <span class="stringliteral">"s3.socket-timeout-ms"</span>;</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>};</div> |
| </div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace iceberg::arrow</span></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html">iceberg::arrow::S3Properties</a></div><div class="ttdoc">S3 configuration property keys for ArrowS3FileIO.</div><div class="ttdef"><b>Definition</b> s3_properties.h:31</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a14889abe7efdfb7be4fc0d6f2ecaade9"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a14889abe7efdfb7be4fc0d6f2ecaade9">iceberg::arrow::S3Properties::kSecretAccessKey</a></div><div class="ttdeci">static constexpr std::string_view kSecretAccessKey</div><div class="ttdoc">AWS secret access key.</div><div class="ttdef"><b>Definition</b> s3_properties.h:37</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a30e6db54fade15dc71a3d96acb4b2cf2"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a30e6db54fade15dc71a3d96acb4b2cf2">iceberg::arrow::S3Properties::kS3Schema</a></div><div class="ttdeci">static constexpr std::string_view kS3Schema</div><div class="ttdoc">S3 URI scheme.</div><div class="ttdef"><b>Definition</b> s3_properties.h:33</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a3b0bc87f9ac7c4e3fbb0ada424742a8f"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a3b0bc87f9ac7c4e3fbb0ada424742a8f">iceberg::arrow::S3Properties::kSocketTimeoutMs</a></div><div class="ttdeci">static constexpr std::string_view kSocketTimeoutMs</div><div class="ttdoc">Socket timeout in milliseconds.</div><div class="ttdef"><b>Definition</b> s3_properties.h:51</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a4dec61230ee68d2b9bbcf8dbc999c6c8"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a4dec61230ee68d2b9bbcf8dbc999c6c8">iceberg::arrow::S3Properties::kSessionToken</a></div><div class="ttdeci">static constexpr std::string_view kSessionToken</div><div class="ttdoc">AWS session token (for temporary credentials)</div><div class="ttdef"><b>Definition</b> s3_properties.h:39</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a65574ce4f661cbc8d8a411c1c6a35e31"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a65574ce4f661cbc8d8a411c1c6a35e31">iceberg::arrow::S3Properties::kRegion</a></div><div class="ttdeci">static constexpr std::string_view kRegion</div><div class="ttdoc">AWS region.</div><div class="ttdef"><b>Definition</b> s3_properties.h:41</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a66135f09349d2c6d3babb892a0f2d28b"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a66135f09349d2c6d3babb892a0f2d28b">iceberg::arrow::S3Properties::kPathStyleAccess</a></div><div class="ttdeci">static constexpr std::string_view kPathStyleAccess</div><div class="ttdoc">Whether to use path-style access (needed for MinIO)</div><div class="ttdef"><b>Definition</b> s3_properties.h:45</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a74b91b99b163d51c58a402d0f83455d6"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a74b91b99b163d51c58a402d0f83455d6">iceberg::arrow::S3Properties::kAccessKeyId</a></div><div class="ttdeci">static constexpr std::string_view kAccessKeyId</div><div class="ttdoc">AWS access key ID.</div><div class="ttdef"><b>Definition</b> s3_properties.h:35</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a80f30f9b8a5d743a59b7a5b9c56e9b5d"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a80f30f9b8a5d743a59b7a5b9c56e9b5d">iceberg::arrow::S3Properties::kConnectTimeoutMs</a></div><div class="ttdeci">static constexpr std::string_view kConnectTimeoutMs</div><div class="ttdoc">Connection timeout in milliseconds.</div><div class="ttdef"><b>Definition</b> s3_properties.h:49</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_a99156e6180c4a40fc23504f01c59ee40"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#a99156e6180c4a40fc23504f01c59ee40">iceberg::arrow::S3Properties::kEndpoint</a></div><div class="ttdeci">static constexpr std::string_view kEndpoint</div><div class="ttdoc">Custom endpoint override (for MinIO, LocalStack, etc.)</div><div class="ttdef"><b>Definition</b> s3_properties.h:43</div></div> |
| <div class="ttc" id="astructiceberg_1_1arrow_1_1S3Properties_html_ab54266a1acc0977d8ed9bf83fe54e223"><div class="ttname"><a href="structiceberg_1_1arrow_1_1S3Properties.html#ab54266a1acc0977d8ed9bf83fe54e223">iceberg::arrow::S3Properties::kSslEnabled</a></div><div class="ttdeci">static constexpr std::string_view kSslEnabled</div><div class="ttdoc">Whether SSL is enabled.</div><div class="ttdef"><b>Definition</b> s3_properties.h:47</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
