> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# kinetica.AggregateKMeansRequest.Options

> kinetica.AggregateKMeansRequest.Options — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1AggregateKMeansRequest#a4c7705d78798730d956903f4a764e20a" title="Optional parameters.">AggregateKMeansRequest.options</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-static-attribs" />

            Static Public Attributes
          </h2>
        </td>
      </tr>

      <tr className="memitem:a840b043d89810b0113bc6ca9ff8c82e5" id="r_a840b043d89810b0113bc6ca9ff8c82e5">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a840b043d89810b0113bc6ca9ff8c82e5">WHITEN</a> = "whiten"</td>
      </tr>

      <tr className="memdesc:a840b043d89810b0113bc6ca9ff8c82e5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">When set to 1 each of the columns is first normalized by its stdv - default is not to whiten. <br /></td>
      </tr>

      <tr className="separator:a840b043d89810b0113bc6ca9ff8c82e5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a6a2729f6e4274e1fa093e559f88abdb8" id="r_a6a2729f6e4274e1fa093e559f88abdb8">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6a2729f6e4274e1fa093e559f88abdb8">MAX\_ITERS</a> = "max\_iters"</td>
      </tr>

      <tr className="memdesc:a6a2729f6e4274e1fa093e559f88abdb8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Number of times to try to hit the tolerance limit before giving up - default is 10. <br /></td>
      </tr>

      <tr className="separator:a6a2729f6e4274e1fa093e559f88abdb8">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:aed3f3ae842c5c146bd25c89be19f0ab9" id="r_aed3f3ae842c5c146bd25c89be19f0ab9">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aed3f3ae842c5c146bd25c89be19f0ab9">NUM\_TRIES</a> = "num\_tries"</td>
      </tr>

      <tr className="memdesc:aed3f3ae842c5c146bd25c89be19f0ab9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. <br /></td>
      </tr>

      <tr className="separator:aed3f3ae842c5c146bd25c89be19f0ab9">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a527111eba7853f7fb24d09c95d2dd363" id="r_a527111eba7853f7fb24d09c95d2dd363">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a527111eba7853f7fb24d09c95d2dd363">CREATE\_TEMP\_TABLE</a> = "create\_temp\_table"</td>
      </tr>

      <tr className="memdesc:a527111eba7853f7fb24d09c95d2dd363">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If <a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a>. <br /></td>
      </tr>

      <tr className="separator:a527111eba7853f7fb24d09c95d2dd363">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a27b6f91991a854762ad88e18537aa806" id="r_a27b6f91991a854762ad88e18537aa806">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a> = "true"</td>
      </tr>

      <tr className="memdesc:a27b6f91991a854762ad88e18537aa806">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateKMeansRequest_1_1Options" title="A set of string constants for the parameter AggregateKMeansRequest.options.">AggregateKMeansRequest.Options</a> options. <br /></td>
      </tr>

      <tr className="separator:a27b6f91991a854762ad88e18537aa806">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac8b4cc24923a39ef66034caabb30447c" id="r_ac8b4cc24923a39ef66034caabb30447c">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a> = "false"</td>
      </tr>

      <tr className="memdesc:ac8b4cc24923a39ef66034caabb30447c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateKMeansRequest_1_1Options" title="A set of string constants for the parameter AggregateKMeansRequest.options.">AggregateKMeansRequest.Options</a> options. <br /></td>
      </tr>

      <tr className="separator:ac8b4cc24923a39ef66034caabb30447c">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ab55f2311c9107c388b79100590f43ba6" id="r_ab55f2311c9107c388b79100590f43ba6">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a> = "result\_table"</td>
      </tr>

      <tr className="memdesc:ab55f2311c9107c388b79100590f43ba6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The name of a table used to store the results, in \[schema\_name. <br /></td>
      </tr>

      <tr className="separator:ab55f2311c9107c388b79100590f43ba6">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a332e06873113d4241442058d144f5e71" id="r_a332e06873113d4241442058d144f5e71">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a332e06873113d4241442058d144f5e71">RESULT\_TABLE\_PERSIST</a> = "result\_table\_persist"</td>
      </tr>

      <tr className="memdesc:a332e06873113d4241442058d144f5e71">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If <a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a>, then the result table specified in <a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a> will be persisted and will not expire unless a <a className="el" href="#a0b08a0f826509458be51b38834bb9b78">TTL</a> is specified. <br /></td>
      </tr>

      <tr className="separator:a332e06873113d4241442058d144f5e71">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a0b08a0f826509458be51b38834bb9b78" id="r_a0b08a0f826509458be51b38834bb9b78">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0b08a0f826509458be51b38834bb9b78">TTL</a> = "ttl"</td>
      </tr>

      <tr className="memdesc:a0b08a0f826509458be51b38834bb9b78">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the table specified in <a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a>. <br /></td>
      </tr>

      <tr className="separator:a0b08a0f826509458be51b38834bb9b78">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <div id="details" />

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1AggregateKMeansRequest#a4c7705d78798730d956903f4a764e20a" title="Optional parameters.">AggregateKMeansRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L30">30</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="a527111eba7853f7fb24d09c95d2dd363" />

    <h2 className="memtitle"><span className="permalink"><a href="#a527111eba7853f7fb24d09c95d2dd363">◆ </a></span>CREATE\_TEMP\_TABLE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.CREATE\_TEMP\_TABLE = "create\_temp\_table"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>If <a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a>. </p>
        <p>If <a className="el" href="#a332e06873113d4241442058d144f5e71">RESULT\_TABLE\_PERSIST</a> is <a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a> (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cs/structkinetica_1_1AggregateKMeansResponse_1_1Info#a35cce0ebdb3f7ee429e50b44e9ea695a">QUALIFIED\_RESULT\_TABLE\_NAME</a>. Supported values:</p>

        <ul>
          <li> <a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a> </li>
          <li> <a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L75">75</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="ac8b4cc24923a39ef66034caabb30447c" />

    <h2 className="memtitle"><span className="permalink"><a href="#ac8b4cc24923a39ef66034caabb30447c">◆ </a></span>FALSE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.FALSE = "false"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateKMeansRequest_1_1Options" title="A set of string constants for the parameter AggregateKMeansRequest.options.">AggregateKMeansRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L83">83</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="a6a2729f6e4274e1fa093e559f88abdb8" />

    <h2 className="memtitle"><span className="permalink"><a href="#a6a2729f6e4274e1fa093e559f88abdb8">◆ </a></span>MAX\_ITERS</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.MAX\_ITERS = "max\_iters"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Number of times to try to hit the tolerance limit before giving up - default is 10. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L38">38</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="aed3f3ae842c5c146bd25c89be19f0ab9" />

    <h2 className="memtitle"><span className="permalink"><a href="#aed3f3ae842c5c146bd25c89be19f0ab9">◆ </a></span>NUM\_TRIES</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.NUM\_TRIES = "num\_tries"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. </p>
        <p>Default is 1.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L44">44</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="ab55f2311c9107c388b79100590f43ba6" />

    <h2 className="memtitle"><span className="permalink"><a href="#ab55f2311c9107c388b79100590f43ba6">◆ </a></span>RESULT\_TABLE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.RESULT\_TABLE = "result\_table"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The name of a table used to store the results, in \[schema\_name. </p>
        <p>]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. </p>
        <p>If this option is specified, the results are not returned in the response.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L93">93</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="a332e06873113d4241442058d144f5e71" />

    <h2 className="memtitle"><span className="permalink"><a href="#a332e06873113d4241442058d144f5e71">◆ </a></span>RESULT\_TABLE\_PERSIST</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.RESULT\_TABLE\_PERSIST = "result\_table\_persist"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>If <a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a>, then the result table specified in <a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a> will be persisted and will not expire unless a <a className="el" href="#a0b08a0f826509458be51b38834bb9b78">TTL</a> is specified. </p>
        <p>If <a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a>, then the result table will be an in-memory table and will expire unless a <a className="el" href="#a0b08a0f826509458be51b38834bb9b78">TTL</a> is specified otherwise. Supported values:</p>

        <ul>
          <li> <a className="el" href="#a27b6f91991a854762ad88e18537aa806">TRUE</a> </li>
          <li> <a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#ac8b4cc24923a39ef66034caabb30447c">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L123">123</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="a27b6f91991a854762ad88e18537aa806" />

    <h2 className="memtitle"><span className="permalink"><a href="#a27b6f91991a854762ad88e18537aa806">◆ </a></span>TRUE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.TRUE = "true"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateKMeansRequest_1_1Options" title="A set of string constants for the parameter AggregateKMeansRequest.options.">AggregateKMeansRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L79">79</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="a0b08a0f826509458be51b38834bb9b78" />

    <h2 className="memtitle"><span className="permalink"><a href="#a0b08a0f826509458be51b38834bb9b78">◆ </a></span>TTL</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.TTL = "ttl"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the table specified in <a className="el" href="#ab55f2311c9107c388b79100590f43ba6">RESULT\_TABLE</a>. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L129">129</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <div id="a840b043d89810b0113bc6ca9ff8c82e5" />

    <h2 className="memtitle"><span className="permalink"><a href="#a840b043d89810b0113bc6ca9ff8c82e5">◆ </a></span>WHITEN</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AggregateKMeansRequest.Options.WHITEN = "whiten"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>When set to 1 each of the columns is first normalized by its stdv - default is not to whiten. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs#L34">34</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AggregateKMeans.cs">AggregateKMeans.cs</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.