mkdocs/docs/api/xml/auth__properties_8h.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.8" xml:lang="en-US">
  <compounddef id="auth__properties_8h" kind="file" language="C++">
    <compoundname>auth_properties.h</compoundname>
    <includes local="no">string</includes>
    <includes local="no">string_view</includes>
    <includedby refid="auth__manager_8cc" local="yes">iceberg/catalog/rest/auth/auth_manager.cc</includedby>
    <includedby refid="auth__managers_8cc" local="yes">iceberg/catalog/rest/auth/auth_managers.cc</includedby>
    <includedby refid="auth__manager__test_8cc" local="yes">iceberg/test/auth_manager_test.cc</includedby>
    <incdepgraph>
      <node id="1">
        <label>iceberg/catalog/rest/auth/auth_properties.h</label>
        <link refid="auth__properties_8h"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>string</label>
      </node>
      <node id="3">
        <label>string_view</label>
      </node>
    </incdepgraph>
    <innerclass refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties" prot="public">iceberg::rest::auth::AuthProperties</innerclass>
    <innernamespace refid="namespaceiceberg">iceberg</innernamespace>
    <innernamespace refid="namespaceiceberg_1_1rest">iceberg::rest</innernamespace>
    <innernamespace refid="namespaceiceberg_1_1rest_1_1auth">iceberg::rest::auth</innernamespace>
    <briefdescription>
<para>Property keys and constants for REST catalog authentication. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="comment">/*</highlight></codeline>
<codeline lineno="2"><highlight class="comment"><sp/>*<sp/>Licensed<sp/>to<sp/>the<sp/>Apache<sp/>Software<sp/>Foundation<sp/>(ASF)<sp/>under<sp/>one</highlight></codeline>
<codeline lineno="3"><highlight class="comment"><sp/>*<sp/>or<sp/>more<sp/>contributor<sp/>license<sp/>agreements.<sp/><sp/>See<sp/>the<sp/>NOTICE<sp/>file</highlight></codeline>
<codeline lineno="4"><highlight class="comment"><sp/>*<sp/>distributed<sp/>with<sp/>this<sp/>work<sp/>for<sp/>additional<sp/>information</highlight></codeline>
<codeline lineno="5"><highlight class="comment"><sp/>*<sp/>regarding<sp/>copyright<sp/>ownership.<sp/><sp/>The<sp/>ASF<sp/>licenses<sp/>this<sp/>file</highlight></codeline>
<codeline lineno="6"><highlight class="comment"><sp/>*<sp/>to<sp/>you<sp/>under<sp/>the<sp/>Apache<sp/>License,<sp/>Version<sp/>2.0<sp/>(the</highlight></codeline>
<codeline lineno="7"><highlight class="comment"><sp/>*<sp/>&quot;License&quot;);<sp/>you<sp/>may<sp/>not<sp/>use<sp/>this<sp/>file<sp/>except<sp/>in<sp/>compliance</highlight></codeline>
<codeline lineno="8"><highlight class="comment"><sp/>*<sp/>with<sp/>the<sp/>License.<sp/><sp/>You<sp/>may<sp/>obtain<sp/>a<sp/>copy<sp/>of<sp/>the<sp/>License<sp/>at</highlight></codeline>
<codeline lineno="9"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="10"><highlight class="comment"><sp/>*<sp/><sp/><sp/>http://www.apache.org/licenses/LICENSE-2.0</highlight></codeline>
<codeline lineno="11"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="12"><highlight class="comment"><sp/>*<sp/>Unless<sp/>required<sp/>by<sp/>applicable<sp/>law<sp/>or<sp/>agreed<sp/>to<sp/>in<sp/>writing,</highlight></codeline>
<codeline lineno="13"><highlight class="comment"><sp/>*<sp/>software<sp/>distributed<sp/>under<sp/>the<sp/>License<sp/>is<sp/>distributed<sp/>on<sp/>an</highlight></codeline>
<codeline lineno="14"><highlight class="comment"><sp/>*<sp/>&quot;AS<sp/>IS&quot;<sp/>BASIS,<sp/>WITHOUT<sp/>WARRANTIES<sp/>OR<sp/>CONDITIONS<sp/>OF<sp/>ANY</highlight></codeline>
<codeline lineno="15"><highlight class="comment"><sp/>*<sp/>KIND,<sp/>either<sp/>express<sp/>or<sp/>implied.<sp/><sp/>See<sp/>the<sp/>License<sp/>for<sp/>the</highlight></codeline>
<codeline lineno="16"><highlight class="comment"><sp/>*<sp/>specific<sp/>language<sp/>governing<sp/>permissions<sp/>and<sp/>limitations</highlight></codeline>
<codeline lineno="17"><highlight class="comment"><sp/>*<sp/>under<sp/>the<sp/>License.</highlight></codeline>
<codeline lineno="18"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight></codeline>
<codeline lineno="22"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="23"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string_view&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight></codeline>
<codeline lineno="27"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">iceberg::rest::auth<sp/>{</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="34" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties" refkind="compound"><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties" kindref="compound">AuthProperties</ref><sp/>{</highlight></codeline>
<codeline lineno="36" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a46cab002d49cac707eaf1db737f43fb5" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a46cab002d49cac707eaf1db737f43fb5" kindref="member">kAuthType</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;rest.auth.type&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="38" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1af7176f5743cbb958b6cdeca6b36d6205" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1af7176f5743cbb958b6cdeca6b36d6205" kindref="member">kAuthTypeNone</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;none&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="40" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1ad0c6fc6cca23b59c1513977ff7377851" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1ad0c6fc6cca23b59c1513977ff7377851" kindref="member">kAuthTypeBasic</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;basic&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="42" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a2bcd4dacfef4b100f2659e0ba80ff539" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a2bcd4dacfef4b100f2659e0ba80ff539" kindref="member">kAuthTypeOAuth2</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;oauth2&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="44" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a8eacab90e2a4c10aee6c753d7fb01401" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a8eacab90e2a4c10aee6c753d7fb01401" kindref="member">kAuthTypeSigV4</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;sigv4&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="47" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1aeb24478a173e654ba4025ecb3fd28685" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1aeb24478a173e654ba4025ecb3fd28685" kindref="member">kBasicUsername</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;rest.auth.basic.username&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="49" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1adec7f7b8606b127d8514b1a1fa6cce29" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1adec7f7b8606b127d8514b1a1fa6cce29" kindref="member">kBasicPassword</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;rest.auth.basic.password&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="50"><highlight class="normal"></highlight></codeline>
<codeline lineno="52" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a7e7b7dbe464be4ff5f659d4066ef9539" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a7e7b7dbe464be4ff5f659d4066ef9539" kindref="member">kOAuth2Token</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;token&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="54" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a4f6aa758fb7bd600031f450505836f66" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a4f6aa758fb7bd600031f450505836f66" kindref="member">kOAuth2Credential</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;credential&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="56" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1ae152d0229afb5886204033d43cf3e402" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1ae152d0229afb5886204033d43cf3e402" kindref="member">kOAuth2Scope</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;scope&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="58" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a9602087ebad5d61de6fc316621acd3b0" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a9602087ebad5d61de6fc316621acd3b0" kindref="member">kOAuth2ServerUri</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;oauth2-server-uri&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="60" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a86016f32faa877d86b7ddb7007093e75" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a86016f32faa877d86b7ddb7007093e75" kindref="member">kOAuth2TokenRefreshEnabled</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;token-refresh-enabled&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="62" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1ac28186fa752468138ad5504f6b8c0571" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1ac28186fa752468138ad5504f6b8c0571" kindref="member">kOAuth2DefaultScope</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;catalog&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="63"><highlight class="normal"></highlight></codeline>
<codeline lineno="65" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1aa69823da0ab682eb134efdd596e84de3" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1aa69823da0ab682eb134efdd596e84de3" kindref="member">kSigV4Region</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;rest.auth.sigv4.region&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="67" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a2015a6bdd368668ec4d33f1a24a02fa2" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a2015a6bdd368668ec4d33f1a24a02fa2" kindref="member">kSigV4Service</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;rest.auth.sigv4.service&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="69" refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a055cc0337696cac908e2370c961b2277" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::string<sp/><ref refid="structiceberg_1_1rest_1_1auth_1_1AuthProperties_1a055cc0337696cac908e2370c961b2277" kindref="member">kSigV4DelegateAuthType</ref><sp/>=</highlight></codeline>
<codeline lineno="70"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;rest.auth.sigv4.delegate-auth-type&quot;</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="71"><highlight class="normal">};</highlight></codeline>
<codeline lineno="72"><highlight class="normal"></highlight></codeline>
<codeline lineno="73"><highlight class="normal">}<sp/><sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>iceberg::rest::auth</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="iceberg/catalog/rest/auth/auth_properties.h"/>
  </compounddef>
</doxygen>