Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1rest_1_1auth_1_1AuthProperties.html
blob: d5705ba858731b7c0f2620673a5a24a6fa7f16b8 [file]
<!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::rest::auth::AuthProperties Class Reference</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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"><b>iceberg</b></li><li class="navelem"><b>rest</b></li><li class="navelem"><b>auth</b></li><li class="navelem"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">AuthProperties</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::rest::auth::AuthProperties Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Authentication properties.
<a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="auth__properties_8h_source.html">auth_properties.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::rest::auth::AuthProperties:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1rest_1_1auth_1_1AuthProperties.png" usemap="#iceberg::rest::auth::AuthProperties_map" alt=""/>
<map id="iceberg::rest::auth::AuthProperties_map" name="iceberg::rest::auth::AuthProperties_map">
<area href="classiceberg_1_1ConfigBase.html" alt="iceberg::ConfigBase&lt; AuthProperties &gt;" shape="rect" coords="0,0,234,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a7b11be3f0407699ba7ab8850420616a7" id="r_a7b11be3f0407699ba7ab8850420616a7"><td class="memTemplParams" colspan="2"><a id="a7b11be3f0407699ba7ab8850420616a7" name="a7b11be3f0407699ba7ab8850420616a7"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a7b11be3f0407699ba7ab8850420616a7"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Entry</b> = const <a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a>&lt; <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">AuthProperties</a> &gt;::Entry&lt; T &gt;</td></tr>
<tr class="separator:a7b11be3f0407699ba7ab8850420616a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abf994144d9b4a7a4a90b724b77b6c26c" id="r_abf994144d9b4a7a4a90b724b77b6c26c"><td class="memItemLeft" align="right" valign="top"><a id="abf994144d9b4a7a4a90b724b77b6c26c" name="abf994144d9b4a7a4a90b724b77b6c26c"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>token</b> () const</td></tr>
<tr class="memdesc:abf994144d9b4a7a4a90b724b77b6c26c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the bearer token. <br /></td></tr>
<tr class="separator:abf994144d9b4a7a4a90b724b77b6c26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ef10527c950afc8ea7d2890c5c3bcdf" id="r_a1ef10527c950afc8ea7d2890c5c3bcdf"><td class="memItemLeft" align="right" valign="top"><a id="a1ef10527c950afc8ea7d2890c5c3bcdf" name="a1ef10527c950afc8ea7d2890c5c3bcdf"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>credential</b> () const</td></tr>
<tr class="memdesc:a1ef10527c950afc8ea7d2890c5c3bcdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the raw credential string. <br /></td></tr>
<tr class="separator:a1ef10527c950afc8ea7d2890c5c3bcdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bf9004c9134712b456ec7188f65fd87" id="r_a9bf9004c9134712b456ec7188f65fd87"><td class="memItemLeft" align="right" valign="top"><a id="a9bf9004c9134712b456ec7188f65fd87" name="a9bf9004c9134712b456ec7188f65fd87"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>scope</b> () const</td></tr>
<tr class="memdesc:a9bf9004c9134712b456ec7188f65fd87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the OAuth2 scope. <br /></td></tr>
<tr class="separator:a9bf9004c9134712b456ec7188f65fd87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2de70e190a117ccdd1a460abd4a1da27" id="r_a2de70e190a117ccdd1a460abd4a1da27"><td class="memItemLeft" align="right" valign="top"><a id="a2de70e190a117ccdd1a460abd4a1da27" name="a2de70e190a117ccdd1a460abd4a1da27"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>oauth2_server_uri</b> () const</td></tr>
<tr class="memdesc:a2de70e190a117ccdd1a460abd4a1da27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the token endpoint URI. <br /></td></tr>
<tr class="separator:a2de70e190a117ccdd1a460abd4a1da27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5dcc0573e8885878a9ee885adee9871" id="r_ae5dcc0573e8885878a9ee885adee9871"><td class="memItemLeft" align="right" valign="top"><a id="ae5dcc0573e8885878a9ee885adee9871" name="ae5dcc0573e8885878a9ee885adee9871"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>keep_refreshed</b> () const</td></tr>
<tr class="memdesc:ae5dcc0573e8885878a9ee885adee9871"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether token refresh is enabled. <br /></td></tr>
<tr class="separator:ae5dcc0573e8885878a9ee885adee9871"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b71a671c13d68aa09858989fa948490" id="r_a6b71a671c13d68aa09858989fa948490"><td class="memItemLeft" align="right" valign="top"><a id="a6b71a671c13d68aa09858989fa948490" name="a6b71a671c13d68aa09858989fa948490"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>exchange_enabled</b> () const</td></tr>
<tr class="memdesc:a6b71a671c13d68aa09858989fa948490"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether token exchange is enabled. <br /></td></tr>
<tr class="separator:a6b71a671c13d68aa09858989fa948490"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb9a674a365dad9149c9025982b3f61b" id="r_acb9a674a365dad9149c9025982b3f61b"><td class="memItemLeft" align="right" valign="top"><a id="acb9a674a365dad9149c9025982b3f61b" name="acb9a674a365dad9149c9025982b3f61b"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>client_id</b> () const</td></tr>
<tr class="memdesc:acb9a674a365dad9149c9025982b3f61b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parsed client_id from credential (empty if no colon). <br /></td></tr>
<tr class="separator:acb9a674a365dad9149c9025982b3f61b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ad096600233a1cce6cddd9e17a18e9" id="r_a89ad096600233a1cce6cddd9e17a18e9"><td class="memItemLeft" align="right" valign="top"><a id="a89ad096600233a1cce6cddd9e17a18e9" name="a89ad096600233a1cce6cddd9e17a18e9"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>client_secret</b> () const</td></tr>
<tr class="memdesc:a89ad096600233a1cce6cddd9e17a18e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parsed client_secret from credential. <br /></td></tr>
<tr class="separator:a89ad096600233a1cce6cddd9e17a18e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0196f616aa5a29422b52ac5d4a2266ce" id="r_a0196f616aa5a29422b52ac5d4a2266ce"><td class="memItemLeft" align="right" valign="top"><a id="a0196f616aa5a29422b52ac5d4a2266ce" name="a0196f616aa5a29422b52ac5d4a2266ce"></a>
std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>optional_oauth_params</b> () const</td></tr>
<tr class="memdesc:a0196f616aa5a29422b52ac5d4a2266ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build optional OAuth params (audience, resource) from config. <br /></td></tr>
<tr class="separator:a0196f616aa5a29422b52ac5d4a2266ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1ConfigBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1ConfigBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1ConfigBase.html">iceberg::ConfigBase&lt; AuthProperties &gt;</a></td></tr>
<tr class="memitem:a3c626ca9dd5adf5a1f2e72d3f751059c inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a3c626ca9dd5adf5a1f2e72d3f751059c"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Set</b> (const Entry&lt; T &gt; &amp;entry, const T &amp;val)</td></tr>
<tr class="separator:a3c626ca9dd5adf5a1f2e72d3f751059c inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fe814df79a9ed72e34fa9d7e6e8d443 inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a1fe814df79a9ed72e34fa9d7e6e8d443"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Unset</b> (const Entry&lt; T &gt; &amp;entry)</td></tr>
<tr class="separator:a1fe814df79a9ed72e34fa9d7e6e8d443 inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95b58a9275880fc2437210f42e8946f2 inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a95b58a9275880fc2437210f42e8946f2"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Reset</b> ()</td></tr>
<tr class="separator:a95b58a9275880fc2437210f42e8946f2 inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a793c5c7e230dac7b87c16200f8263db6 inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a793c5c7e230dac7b87c16200f8263db6"><td class="memItemLeft" align="right" valign="top">
T&#160;</td><td class="memItemRight" valign="bottom"><b>Get</b> (const Entry&lt; T &gt; &amp;entry) const</td></tr>
<tr class="separator:a793c5c7e230dac7b87c16200f8263db6 inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a464281576df4a683611d8319e578257c inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a464281576df4a683611d8319e578257c"><td class="memItemLeft" align="right" valign="top">
const std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>configs</b> () const</td></tr>
<tr class="separator:a464281576df4a683611d8319e578257c inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75f09e1cd2bb55b4df854298ed678313 inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a75f09e1cd2bb55b4df854298ed678313"><td class="memItemLeft" align="right" valign="top">
std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>mutable_configs</b> ()</td></tr>
<tr class="separator:a75f09e1cd2bb55b4df854298ed678313 inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78dc1c7d65af1e096a19fc77d2c9ed39 inherit pub_methods_classiceberg_1_1ConfigBase" id="r_a78dc1c7d65af1e096a19fc77d2c9ed39"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ConfigBase.html#a78dc1c7d65af1e096a19fc77d2c9ed39">Extract</a> (std::string_view prefix) const</td></tr>
<tr class="memdesc:a78dc1c7d65af1e096a19fc77d2c9ed39 inherit pub_methods_classiceberg_1_1ConfigBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the prefix from the configuration. <br /></td></tr>
<tr class="separator:a78dc1c7d65af1e096a19fc77d2c9ed39 inherit pub_methods_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a727340e935fb440f9d1b2249c11de77a" id="r_a727340e935fb440f9d1b2249c11de77a"><td class="memItemLeft" align="right" valign="top"><a id="a727340e935fb440f9d1b2249c11de77a" name="a727340e935fb440f9d1b2249c11de77a"></a>
static Result&lt; <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">AuthProperties</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>FromProperties</b> (const std::unordered_map&lt; std::string, std::string &gt; &amp;properties)</td></tr>
<tr class="memdesc:a727340e935fb440f9d1b2249c11de77a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build an <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html" title="Authentication properties.">AuthProperties</a> from a properties map. <br /></td></tr>
<tr class="separator:a727340e935fb440f9d1b2249c11de77a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a46cab002d49cac707eaf1db737f43fb5" id="r_a46cab002d49cac707eaf1db737f43fb5"><td class="memItemLeft" align="right" valign="top"><a id="a46cab002d49cac707eaf1db737f43fb5" name="a46cab002d49cac707eaf1db737f43fb5"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kAuthType</b> = &quot;rest.auth.type&quot;</td></tr>
<tr class="separator:a46cab002d49cac707eaf1db737f43fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7176f5743cbb958b6cdeca6b36d6205" id="r_af7176f5743cbb958b6cdeca6b36d6205"><td class="memItemLeft" align="right" valign="top"><a id="af7176f5743cbb958b6cdeca6b36d6205" name="af7176f5743cbb958b6cdeca6b36d6205"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kAuthTypeNone</b> = &quot;none&quot;</td></tr>
<tr class="separator:af7176f5743cbb958b6cdeca6b36d6205"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0c6fc6cca23b59c1513977ff7377851" id="r_ad0c6fc6cca23b59c1513977ff7377851"><td class="memItemLeft" align="right" valign="top"><a id="ad0c6fc6cca23b59c1513977ff7377851" name="ad0c6fc6cca23b59c1513977ff7377851"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kAuthTypeBasic</b> = &quot;basic&quot;</td></tr>
<tr class="separator:ad0c6fc6cca23b59c1513977ff7377851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bcd4dacfef4b100f2659e0ba80ff539" id="r_a2bcd4dacfef4b100f2659e0ba80ff539"><td class="memItemLeft" align="right" valign="top"><a id="a2bcd4dacfef4b100f2659e0ba80ff539" name="a2bcd4dacfef4b100f2659e0ba80ff539"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kAuthTypeOAuth2</b> = &quot;oauth2&quot;</td></tr>
<tr class="separator:a2bcd4dacfef4b100f2659e0ba80ff539"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eacab90e2a4c10aee6c753d7fb01401" id="r_a8eacab90e2a4c10aee6c753d7fb01401"><td class="memItemLeft" align="right" valign="top"><a id="a8eacab90e2a4c10aee6c753d7fb01401" name="a8eacab90e2a4c10aee6c753d7fb01401"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kAuthTypeSigV4</b> = &quot;sigv4&quot;</td></tr>
<tr class="separator:a8eacab90e2a4c10aee6c753d7fb01401"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb24478a173e654ba4025ecb3fd28685" id="r_aeb24478a173e654ba4025ecb3fd28685"><td class="memItemLeft" align="right" valign="top"><a id="aeb24478a173e654ba4025ecb3fd28685" name="aeb24478a173e654ba4025ecb3fd28685"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kBasicUsername</b> = &quot;rest.auth.basic.username&quot;</td></tr>
<tr class="separator:aeb24478a173e654ba4025ecb3fd28685"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adec7f7b8606b127d8514b1a1fa6cce29" id="r_adec7f7b8606b127d8514b1a1fa6cce29"><td class="memItemLeft" align="right" valign="top"><a id="adec7f7b8606b127d8514b1a1fa6cce29" name="adec7f7b8606b127d8514b1a1fa6cce29"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kBasicPassword</b> = &quot;rest.auth.basic.password&quot;</td></tr>
<tr class="separator:adec7f7b8606b127d8514b1a1fa6cce29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af282e247167638df4e1fe539842f6b84" id="r_af282e247167638df4e1fe539842f6b84"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#af282e247167638df4e1fe539842f6b84">kSigV4Enabled</a> = &quot;rest.sigv4-enabled&quot;</td></tr>
<tr class="separator:af282e247167638df4e1fe539842f6b84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a055cc0337696cac908e2370c961b2277" id="r_a055cc0337696cac908e2370c961b2277"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a055cc0337696cac908e2370c961b2277">kSigV4DelegateAuthType</a></td></tr>
<tr class="separator:a055cc0337696cac908e2370c961b2277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d5dcfc25e4a2325c43af407f83cbae3" id="r_a1d5dcfc25e4a2325c43af407f83cbae3"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a1d5dcfc25e4a2325c43af407f83cbae3">kSigV4SigningRegion</a> = &quot;rest.signing-region&quot;</td></tr>
<tr class="separator:a1d5dcfc25e4a2325c43af407f83cbae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b1c3bd38dfb2a4702cd76ad26a8409a" id="r_a4b1c3bd38dfb2a4702cd76ad26a8409a"><td class="memItemLeft" align="right" valign="top"><a id="a4b1c3bd38dfb2a4702cd76ad26a8409a" name="a4b1c3bd38dfb2a4702cd76ad26a8409a"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kSigV4SigningName</b> = &quot;rest.signing-name&quot;</td></tr>
<tr class="separator:a4b1c3bd38dfb2a4702cd76ad26a8409a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf01e6154968ced5b82dbdbcbb7b9ef1" id="r_aaf01e6154968ced5b82dbdbcbb7b9ef1"><td class="memItemLeft" align="right" valign="top"><a id="aaf01e6154968ced5b82dbdbcbb7b9ef1" name="aaf01e6154968ced5b82dbdbcbb7b9ef1"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kSigV4SigningNameDefault</b> = &quot;execute-api&quot;</td></tr>
<tr class="separator:aaf01e6154968ced5b82dbdbcbb7b9ef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51985864e01c3e5691428678e59d4430" id="r_a51985864e01c3e5691428678e59d4430"><td class="memItemLeft" align="right" valign="top"><a id="a51985864e01c3e5691428678e59d4430" name="a51985864e01c3e5691428678e59d4430"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kSigV4AccessKeyId</b> = &quot;rest.access-key-id&quot;</td></tr>
<tr class="separator:a51985864e01c3e5691428678e59d4430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a91b656ae9fbec3fa5e8873fd11f5b5" id="r_a1a91b656ae9fbec3fa5e8873fd11f5b5"><td class="memItemLeft" align="right" valign="top"><a id="a1a91b656ae9fbec3fa5e8873fd11f5b5" name="a1a91b656ae9fbec3fa5e8873fd11f5b5"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kSigV4SecretAccessKey</b> = &quot;rest.secret-access-key&quot;</td></tr>
<tr class="separator:a1a91b656ae9fbec3fa5e8873fd11f5b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53cfa533dbe82faaf555d68eb1b72d8e" id="r_a53cfa533dbe82faaf555d68eb1b72d8e"><td class="memItemLeft" align="right" valign="top"><a id="a53cfa533dbe82faaf555d68eb1b72d8e" name="a53cfa533dbe82faaf555d68eb1b72d8e"></a>
static const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>kSigV4SessionToken</b> = &quot;rest.session-token&quot;</td></tr>
<tr class="separator:a53cfa533dbe82faaf555d68eb1b72d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add7d4ada74870c815f75d93ff034d43e" id="r_add7d4ada74870c815f75d93ff034d43e"><td class="memItemLeft" align="right" valign="top"><a id="add7d4ada74870c815f75d93ff034d43e" name="add7d4ada74870c815f75d93ff034d43e"></a>
static Entry&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kToken</b> {&quot;token&quot;, &quot;&quot;}</td></tr>
<tr class="separator:add7d4ada74870c815f75d93ff034d43e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15bf7ad374f8fcd122af58e3602a5313" id="r_a15bf7ad374f8fcd122af58e3602a5313"><td class="memItemLeft" align="right" valign="top"><a id="a15bf7ad374f8fcd122af58e3602a5313" name="a15bf7ad374f8fcd122af58e3602a5313"></a>
static Entry&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kCredential</b> {&quot;credential&quot;, &quot;&quot;}</td></tr>
<tr class="separator:a15bf7ad374f8fcd122af58e3602a5313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6491626c3bad61feb208c2276b223f6" id="r_aa6491626c3bad61feb208c2276b223f6"><td class="memItemLeft" align="right" valign="top"><a id="aa6491626c3bad61feb208c2276b223f6" name="aa6491626c3bad61feb208c2276b223f6"></a>
static Entry&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kScope</b> {&quot;scope&quot;, &quot;catalog&quot;}</td></tr>
<tr class="separator:aa6491626c3bad61feb208c2276b223f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af103cf25e5dcc5ef5244b6d81cdfeaf8" id="r_af103cf25e5dcc5ef5244b6d81cdfeaf8"><td class="memItemLeft" align="right" valign="top">static Entry&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#af103cf25e5dcc5ef5244b6d81cdfeaf8">kOAuth2ServerUri</a></td></tr>
<tr class="separator:af103cf25e5dcc5ef5244b6d81cdfeaf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a692502da607b38deb34ac997ba88b8bb" id="r_a692502da607b38deb34ac997ba88b8bb"><td class="memItemLeft" align="right" valign="top"><a id="a692502da607b38deb34ac997ba88b8bb" name="a692502da607b38deb34ac997ba88b8bb"></a>
static Entry&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kKeepRefreshed</b> {&quot;token-refresh-enabled&quot;, true}</td></tr>
<tr class="separator:a692502da607b38deb34ac997ba88b8bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa613cf8fc2b78db6d147b023d03730fe" id="r_aa613cf8fc2b78db6d147b023d03730fe"><td class="memItemLeft" align="right" valign="top"><a id="aa613cf8fc2b78db6d147b023d03730fe" name="aa613cf8fc2b78db6d147b023d03730fe"></a>
static Entry&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kExchangeEnabled</b> {&quot;token-exchange-enabled&quot;, true}</td></tr>
<tr class="separator:aa613cf8fc2b78db6d147b023d03730fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a632283e1dfc5c1bd7efb8c25835dda78" id="r_a632283e1dfc5c1bd7efb8c25835dda78"><td class="memItemLeft" align="right" valign="top"><a id="a632283e1dfc5c1bd7efb8c25835dda78" name="a632283e1dfc5c1bd7efb8c25835dda78"></a>
static Entry&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kAudience</b> {&quot;audience&quot;, &quot;&quot;}</td></tr>
<tr class="separator:a632283e1dfc5c1bd7efb8c25835dda78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521a59b93959bbc01a04110ee88f0713" id="r_a521a59b93959bbc01a04110ee88f0713"><td class="memItemLeft" align="right" valign="top"><a id="a521a59b93959bbc01a04110ee88f0713" name="a521a59b93959bbc01a04110ee88f0713"></a>
static Entry&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>kResource</b> {&quot;resource&quot;, &quot;&quot;}</td></tr>
<tr class="separator:a521a59b93959bbc01a04110ee88f0713"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classiceberg_1_1ConfigBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classiceberg_1_1ConfigBase')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classiceberg_1_1ConfigBase.html">iceberg::ConfigBase&lt; AuthProperties &gt;</a></td></tr>
<tr class="memitem:a5988dbb52a6ce914c88ef10c66e5bba7 inherit pro_attribs_classiceberg_1_1ConfigBase" id="r_a5988dbb52a6ce914c88ef10c66e5bba7"><td class="memItemLeft" align="right" valign="top">
std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>configs_</b></td></tr>
<tr class="separator:a5988dbb52a6ce914c88ef10c66e5bba7 inherit pro_attribs_classiceberg_1_1ConfigBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Authentication properties. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="af103cf25e5dcc5ef5244b6d81cdfeaf8" name="af103cf25e5dcc5ef5244b6d81cdfeaf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af103cf25e5dcc5ef5244b6d81cdfeaf8">&#9670;&#160;</a></span>kOAuth2ServerUri</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Entry&lt;std::string&gt; iceberg::rest::auth::AuthProperties::kOAuth2ServerUri</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{<span class="stringliteral">&quot;oauth2-server-uri&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;v1/oauth/tokens&quot;</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a055cc0337696cac908e2370c961b2277" name="a055cc0337696cac908e2370c961b2277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a055cc0337696cac908e2370c961b2277">&#9670;&#160;</a></span>kSigV4DelegateAuthType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string iceberg::rest::auth::AuthProperties::kSigV4DelegateAuthType</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> <span class="stringliteral">&quot;rest.auth.sigv4.delegate-auth-type&quot;</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="af282e247167638df4e1fe539842f6b84" name="af282e247167638df4e1fe539842f6b84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af282e247167638df4e1fe539842f6b84">&#9670;&#160;</a></span>kSigV4Enabled</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string iceberg::rest::auth::AuthProperties::kSigV4Enabled = &quot;rest.sigv4-enabled&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated: <code>rest.sigv4-enabled=true</code> selects SigV4 regardless of <code>rest.auth.type</code>. </p>
</div>
</div>
<a id="a1d5dcfc25e4a2325c43af407f83cbae3" name="a1d5dcfc25e4a2325c43af407f83cbae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d5dcfc25e4a2325c43af407f83cbae3">&#9670;&#160;</a></span>kSigV4SigningRegion</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string iceberg::rest::auth::AuthProperties::kSigV4SigningRegion = &quot;rest.signing-region&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>SigV4 signing region. If unset, SigV4 resolves the signing region from AWS environment/profile configuration and fails if no region can be resolved. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/catalog/rest/auth/<a class="el" href="auth__properties_8h_source.html">auth_properties.h</a></li>
<li>iceberg/catalog/rest/auth/<b>auth_properties.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>