> ## 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.

# gpudb::CreateJobRequest

> gpudb::CreateJobRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a02ef4c58e395bbf2c83325cf592397af">GPUdb::createJob</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__job_8h_source">gpudb/protocol/create\_job.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a435a2fd68d20fd21a6437520b887cdf8" id="r_a435a2fd68d20fd21a6437520b887cdf8">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a435a2fd68d20fd21a6437520b887cdf8">CreateJobRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a435a2fd68d20fd21a6437520b887cdf8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest" title="A set of parameters for GPUdb::createJob.">CreateJobRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a6dee05cb560f1ebf4055a9a72a57ddd1" id="r_a6dee05cb560f1ebf4055a9a72a57ddd1">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6dee05cb560f1ebf4055a9a72a57ddd1">CreateJobRequest</a> (const std::string \&endpoint\_, const std::string \&requestEncoding\_, const std::vector\< uint8\_t > \&data\_, const std::string \&dataStr\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a6dee05cb560f1ebf4055a9a72a57ddd1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest" title="A set of parameters for GPUdb::createJob.">CreateJobRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a49f2b83d84738d0da91bb505086f8aaa" id="r_a49f2b83d84738d0da91bb505086f8aaa">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a49f2b83d84738d0da91bb505086f8aaa">endpoint</a></td>
      </tr>

      <tr className="memdesc:a49f2b83d84738d0da91bb505086f8aaa">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Indicates which endpoint to execute, e.g. '/alter/table'. <br /></td>
      </tr>

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

      <tr className="memitem:a71a36f4535f07e2345c034614975fe0b" id="r_a71a36f4535f07e2345c034614975fe0b">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a71a36f4535f07e2345c034614975fe0b">requestEncoding</a></td>
      </tr>

      <tr className="memdesc:a71a36f4535f07e2345c034614975fe0b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The encoding of the request payload for the job. <br /></td>
      </tr>

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

      <tr className="memitem:a7b74f28e470c70ba0ba382a3fce53a24" id="r_a7b74f28e470c70ba0ba382a3fce53a24">
        <td className="memItemLeft" align="right" valign="top">std::vector\< uint8\_t > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7b74f28e470c70ba0ba382a3fce53a24">data</a></td>
      </tr>

      <tr className="memdesc:a7b74f28e470c70ba0ba382a3fce53a24">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Binary-encoded payload for the job to be run asynchronously. <br /></td>
      </tr>

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

      <tr className="memitem:a8ec28dc0d12156c5f5ef44061365ec2f" id="r_a8ec28dc0d12156c5f5ef44061365ec2f">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8ec28dc0d12156c5f5ef44061365ec2f">dataStr</a></td>
      </tr>

      <tr className="memdesc:a8ec28dc0d12156c5f5ef44061365ec2f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">JSON-encoded payload for the job to be run asynchronously. <br /></td>
      </tr>

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

      <tr className="memitem:acab7dd0586ffc1ed0cb2933512ba50b6" id="r_acab7dd0586ffc1ed0cb2933512ba50b6">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acab7dd0586ffc1ed0cb2933512ba50b6">options</a></td>
      </tr>

      <tr className="memdesc:acab7dd0586ffc1ed0cb2933512ba50b6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

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

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a02ef4c58e395bbf2c83325cf592397af">GPUdb::createJob</a>. </p>
      <p>Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a0ff78cb10848a739067c5dbd0a052e05">GPUdb::getJob</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a435a2fd68d20fd21a6437520b887cdf8">◆ </a></span>CreateJobRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateJobRequest::CreateJobRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest" title="A set of parameters for GPUdb::createJob.">CreateJobRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a6dee05cb560f1ebf4055a9a72a57ddd1">◆ </a></span>CreateJobRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateJobRequest::CreateJobRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">endpoint\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">requestEncoding\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::vector\< uint8\_t > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">data\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">dataStr\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest" title="A set of parameters for GPUdb::createJob.">CreateJobRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">endpoint\_</td>
                <td>Indicates which endpoint to execute, e.g. '/alter/table'. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">requestEncoding\_</td>

                <td>
                  The encoding of the request payload for the job. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0258ba3c6c49237f61120ae4d0e7ff08">create\_job\_binary</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a135ca12331c5c022ddb43149122a47b0">create\_job\_json</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83c7f5ccd5607cbacfd3777955101238">create\_job\_snappy</a> </li>
                  </ul>

                  The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a0258ba3c6c49237f61120ae4d0e7ff08">create\_job\_binary</a>.
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">data\_</td>
                <td>Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in <span className="em arg">endpoint\_</span>. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then <span className="em arg">requestEncoding\_</span> must be <a className="el" href="/content/api/cpp/namespacegpudb#a0258ba3c6c49237f61120ae4d0e7ff08">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a83c7f5ccd5607cbacfd3777955101238">snappy</a>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">dataStr\_</td>
                <td>JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in <span className="em arg">endpoint\_</span>. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then <span className="em arg">requestEncoding\_</span> must be <a className="el" href="/content/api/cpp/namespacegpudb#a135ca12331c5c022ddb43149122a47b0">json</a>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5decd9d4fe50c463553fb90c9023d3a5">create\_job\_job\_tag</a>: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '\_' and '-'. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00082">82</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7b74f28e470c70ba0ba382a3fce53a24">◆ </a></span>data</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<uint8\_t> gpudb::CreateJobRequest::data</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Binary-encoded payload for the job to be run asynchronously. </p>
        <p>The payload must contain the relevant input parameters for the endpoint indicated in <a className="el" href="#a49f2b83d84738d0da91bb505086f8aaa">endpoint</a>. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then <a className="el" href="#a71a36f4535f07e2345c034614975fe0b">requestEncoding</a> must be <a className="el" href="/content/api/cpp/namespacegpudb#a0258ba3c6c49237f61120ae4d0e7ff08">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a83c7f5ccd5607cbacfd3777955101238">snappy</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00118">118</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8ec28dc0d12156c5f5ef44061365ec2f">◆ </a></span>dataStr</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateJobRequest::dataStr</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>JSON-encoded payload for the job to be run asynchronously. </p>
        <p>The payload must contain the relevant input parameters for the endpoint indicated in <a className="el" href="#a49f2b83d84738d0da91bb505086f8aaa">endpoint</a>. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then <a className="el" href="#a71a36f4535f07e2345c034614975fe0b">requestEncoding</a> must be <a className="el" href="/content/api/cpp/namespacegpudb#a135ca12331c5c022ddb43149122a47b0">json</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00128">128</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a49f2b83d84738d0da91bb505086f8aaa">◆ </a></span>endpoint</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateJobRequest::endpoint</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Indicates which endpoint to execute, e.g. '/alter/table'. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00094">94</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#acab7dd0586ffc1ed0cb2933512ba50b6">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateJobRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5decd9d4fe50c463553fb90c9023d3a5">create\_job\_job\_tag</a>: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '\_' and '-'. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00140">140</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a71a36f4535f07e2345c034614975fe0b">◆ </a></span>requestEncoding</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateJobRequest::requestEncoding</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The encoding of the request payload for the job. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0258ba3c6c49237f61120ae4d0e7ff08">create\_job\_binary</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a135ca12331c5c022ddb43149122a47b0">create\_job\_json</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83c7f5ccd5607cbacfd3777955101238">create\_job\_snappy</a> </li>
        </ul>

        <p>The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a0258ba3c6c49237f61120ae4d0e7ff08">create\_job\_binary</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__job_8h_source#l00107">107</a> of file <a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/create__job_8h_source">create\_job.h</a></li>
    </ul>
  </div>
</div>