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

# createJob

<div className="kinetica-doxygen">
  <div id="a02ef4c58e395bbf2c83325cf592397af" />

  <h2 className="memtitle"><span className="permalink"><a href="#a02ef4c58e395bbf2c83325cf592397af">◆ </a></span>createJob() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">CreateJobResponse</a> gpudb::GPUdb::createJob </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest">CreateJobRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Create a job which will run asynchronously. </p>
      <p>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="#a0ff78cb10848a739067c5dbd0a052e05">getJob</a>.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a09c09f08b2e5805ff3740daa3eaa06c1" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">CreateJobResponse</a> & gpudb::GPUdb::createJob </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest">CreateJobRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">CreateJobResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Create a job which will run asynchronously. </p>
      <p>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="#a0ff78cb10848a739067c5dbd0a052e05">getJob</a>.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a2807b0831529b2f2e6fb554339670763" />

  <h2 className="memtitle"><span className="permalink"><a href="#a2807b0831529b2f2e6fb554339670763">◆ </a></span>createJob() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">CreateJobResponse</a> gpudb::GPUdb::createJob </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Create a job which will run asynchronously. </p>
      <p>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="#a8f46b312a6700634204dec278fe18b98">getJob</a>.</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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="ab9d0718a56686729612f1b0917601983" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab9d0718a56686729612f1b0917601983">◆ </a></span>createJob() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">CreateJobResponse</a> & gpudb::GPUdb::createJob </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>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">CreateJobResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Create a job which will run asynchronously. </p>
      <p>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="#a8f46b312a6700634204dec278fe18b98">getJob</a>.</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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateJobResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>