api/xml/classiceberg_1_1table_1_1AddEncryptionKey.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="classiceberg_1_1table_1_1AddEncryptionKey" kind="class" language="C++" prot="public">
    <compoundname>iceberg::table::AddEncryptionKey</compoundname>
    <basecompoundref refid="classiceberg_1_1TableUpdate" prot="public" virt="non-virtual">iceberg::TableUpdate</basecompoundref>
    <includes refid="table__update_8h" local="no">table_update.h</includes>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classiceberg_1_1table_1_1AddEncryptionKey_1a61f44cbc40563c2c306240c49125258f" prot="private" static="no" mutable="no">
        <type><ref refid="structiceberg_1_1EncryptedKey" kindref="compound">EncryptedKey</ref></type>
        <definition>EncryptedKey iceberg::table::AddEncryptionKey::key_</definition>
        <argsstring></argsstring>
        <name>key_</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::key_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="632" column="16" bodyfile="iceberg/table_update.h" bodystart="632" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1a80960e1ed9422dc4c8c2ee72b776a4c0" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
        <type></type>
        <definition>iceberg::table::AddEncryptionKey::AddEncryptionKey</definition>
        <argsstring>(EncryptedKey key)</argsstring>
        <name>AddEncryptionKey</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::AddEncryptionKey</qualifiedname>
        <param>
          <type><ref refid="structiceberg_1_1EncryptedKey" kindref="compound">EncryptedKey</ref></type>
          <declname>key</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="617" column="12" bodyfile="iceberg/table_update.h" bodystart="617" bodyend="617"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1ac2c87f5b78d9a72f4e1f43e6e14d6514" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>const <ref refid="structiceberg_1_1EncryptedKey" kindref="compound">EncryptedKey</ref> &amp;</type>
        <definition>const EncryptedKey &amp; iceberg::table::AddEncryptionKey::key</definition>
        <argsstring>() const</argsstring>
        <name>key</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::key</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="619" column="22" bodyfile="iceberg/table_update.h" bodystart="619" bodyend="619"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1afaf69aee9566977b109c957bc86e6db7" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void iceberg::table::AddEncryptionKey::ApplyTo</definition>
        <argsstring>(TableMetadataBuilder &amp;builder) const override</argsstring>
        <name>ApplyTo</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::ApplyTo</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1af07326d407ad45eb6072b586ee6c9485">ApplyTo</reimplements>
        <param>
          <type><ref refid="classiceberg_1_1TableMetadataBuilder" kindref="compound">TableMetadataBuilder</ref> &amp;</type>
          <declname>builder</declname>
        </param>
        <briefdescription>
<para>Apply this update to a <ref refid="classiceberg_1_1TableMetadataBuilder" kindref="compound">TableMetadataBuilder</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para>This method modifies the builder by applying the update operation it represents. Each subclass implements this to apply its specific type of update.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>builder</parametername>
</parameternamelist>
<parameterdescription>
<para>The builder to apply this update to </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="621" column="8"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1a254ac5e85600c0015b11a80f9be55c1b" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void iceberg::table::AddEncryptionKey::GenerateRequirements</definition>
        <argsstring>(TableUpdateContext &amp;context) const override</argsstring>
        <name>GenerateRequirements</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::GenerateRequirements</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1adddc714f83cea93141bc5b771e326e05">GenerateRequirements</reimplements>
        <param>
          <type><ref refid="classiceberg_1_1TableUpdateContext" kindref="compound">TableUpdateContext</ref> &amp;</type>
          <declname>context</declname>
        </param>
        <briefdescription>
<para>Generate update requirements for this metadata update. </para>
        </briefdescription>
        <detaileddescription>
<para>This method generates the appropriate UpdateRequirement instances that must be validated before this update can be applied. The context provides information about the base metadata and operation mode.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>context</parametername>
</parameternamelist>
<parameterdescription>
<para>The context containing base metadata and operation state </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="623" column="8"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1a2ee98e2ab223a4cb3320780ff5a4d0c5" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>Kind</type>
        <definition>Kind iceberg::table::AddEncryptionKey::kind</definition>
        <argsstring>() const override</argsstring>
        <name>kind</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::kind</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1acf1e83fa9835010cda68a6a3387a08a5">kind</reimplements>
        <briefdescription>
<para>Return the kind of this update. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="625" column="8" bodyfile="iceberg/table_update.h" bodystart="625" bodyend="625"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1acaf0dcc170ca240dfcbe6e189bd7cb3b" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>bool</type>
        <definition>bool iceberg::table::AddEncryptionKey::Equals</definition>
        <argsstring>(const TableUpdate &amp;other) const override</argsstring>
        <name>Equals</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::Equals</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1afd0780e6106546f7462e8e66d62db1f2">Equals</reimplements>
        <param>
          <type>const <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref> &amp;</type>
          <declname>other</declname>
        </param>
        <briefdescription>
<para>Check equality with another <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>other</parametername>
</parameternamelist>
<parameterdescription>
<para>The update to compare with </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>true if the updates are equal, false otherwise </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="627" column="8"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1table_1_1AddEncryptionKey_1a84041d1b0ff3fd9c28f2af3acec884ce" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>std::unique_ptr&lt; <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref> &gt;</type>
        <definition>std::unique_ptr&lt; TableUpdate &gt; iceberg::table::AddEncryptionKey::Clone</definition>
        <argsstring>() const override</argsstring>
        <name>Clone</name>
        <qualifiedname>iceberg::table::AddEncryptionKey::Clone</qualifiedname>
        <reimplements refid="classiceberg_1_1TableUpdate_1affb4be490ac63849864bf8ed636363aa">Clone</reimplements>
        <briefdescription>
<para>Create a deep copy of this update. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>A unique_ptr to a new <ref refid="classiceberg_1_1TableUpdate" kindref="compound">TableUpdate</ref> that is a copy of this one </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/table_update.h" line="629" column="19"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Represents adding an encryption key to the table. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>iceberg::TableUpdate</label>
        <link refid="classiceberg_1_1TableUpdate"/>
      </node>
      <node id="1">
        <label>iceberg::table::AddEncryptionKey</label>
        <link refid="classiceberg_1_1table_1_1AddEncryptionKey"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>iceberg::TableUpdate</label>
        <link refid="classiceberg_1_1TableUpdate"/>
      </node>
      <node id="1">
        <label>iceberg::table::AddEncryptionKey</label>
        <link refid="classiceberg_1_1table_1_1AddEncryptionKey"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="iceberg/table_update.h" line="615" column="1" bodyfile="iceberg/table_update.h" bodystart="615" bodyend="633"/>
    <listofallmembers>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1a80960e1ed9422dc4c8c2ee72b776a4c0" prot="public" virt="non-virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>AddEncryptionKey</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1afaf69aee9566977b109c957bc86e6db7" prot="public" virt="virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>ApplyTo</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1a84041d1b0ff3fd9c28f2af3acec884ce" prot="public" virt="virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>Clone</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1acaf0dcc170ca240dfcbe6e189bd7cb3b" prot="public" virt="virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>Equals</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1a254ac5e85600c0015b11a80f9be55c1b" prot="public" virt="virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>GenerateRequirements</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1ac2c87f5b78d9a72f4e1f43e6e14d6514" prot="public" virt="non-virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>key</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1a61f44cbc40563c2c306240c49125258f" prot="private" virt="non-virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>key_</name></member>
      <member refid="classiceberg_1_1table_1_1AddEncryptionKey_1a2ee98e2ab223a4cb3320780ff5a4d0c5" prot="public" virt="virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>kind</name></member>
      <member refid="classiceberg_1_1TableUpdate_1ad8c72b1755b111ad20acff6ae6d4974d" prot="public" virt="non-virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>Kind</name></member>
      <member refid="classiceberg_1_1TableUpdate_1a5967b7662042655f4ca0d9801935d375" prot="public" virt="virtual"><scope>iceberg::table::AddEncryptionKey</scope><name>~TableUpdate</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>