> ## 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="ae37231de334eee413b2fdf5515890e53" />

  <h2 className="memtitle"><span className="permalink"><a href="#ae37231de334eee413b2fdf5515890e53">◆ </a></span>createJob() <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"><a className="el" href="/content/api/cs/classkinetica_1_1CreateJobResponse">CreateJobResponse</a> kinetica.Kinetica.createJob </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1CreateJobRequest">CreateJobRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>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="#afcc40cdc8d8e8e4e2a5a1059354623e6">getJob</a>.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request 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">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L20851">20851</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a516d5b977d617de933c305890bbd8723" />

  <h2 className="memtitle"><span className="permalink"><a href="#a516d5b977d617de933c305890bbd8723">◆ </a></span>createJob() <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"><a className="el" href="/content/api/cs/classkinetica_1_1CreateJobResponse">CreateJobResponse</a> kinetica.Kinetica.createJob </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">endpoint</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">request\_encoding</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">byte\[]</td>
                <td className="paramname"><span className="paramname"><span className="em">data</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">data\_str</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>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="#afcc40cdc8d8e8e4e2a5a1059354623e6">getJob</a>.</p>

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

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

            <tr>
              <td className="paramname">request\_encoding</td>

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

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a118390a860f5844472b2c2dac4bf20dd">BINARY</a> </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a28c36de3f25fc42dbba52af73e28df00">JSON</a> </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#af2addd7006fe60f9b04e645bd97c323c">SNAPPY</a> </li>
                </ul>

                The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a118390a860f5844472b2c2dac4bf20dd">BINARY</a>.
              </td>
            </tr>

            <tr>
              <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">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">request\_encoding</span> must be <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a118390a860f5844472b2c2dac4bf20dd">BINARY</a> or <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#af2addd7006fe60f9b04e645bd97c323c">SNAPPY</a>.</td>
            </tr>

            <tr>
              <td className="paramname">data\_str</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">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">request\_encoding</span> must be <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a28c36de3f25fc42dbba52af73e28df00">JSON</a>.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1Options#a9bf2eba2c7d5556cd540fd16270ad2f3">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 Dictionary.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L20935">20935</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a4ab3abe50cb39012f214d5c04dce45fa" />

  <h2 className="memtitle"><span className="permalink"><a href="#a4ab3abe50cb39012f214d5c04dce45fa">◆ </a></span>CreateJobAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1CreateJobResponse">CreateJobResponse</a> > kinetica.Kinetica.CreateJobAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_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">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Create a job which will run asynchronously. </p>
      <p>(async) </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="#afcc40cdc8d8e8e4e2a5a1059354623e6">getJob</a>.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L20870">20870</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="aaf591ae2ab5b0e2ebc377f6df6f5ded4" />

  <h2 className="memtitle"><span className="permalink"><a href="#aaf591ae2ab5b0e2ebc377f6df6f5ded4">◆ </a></span>CreateJobAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1CreateJobResponse">CreateJobResponse</a> > kinetica.Kinetica.CreateJobAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">endpoint</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">request\_encoding</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">byte\[]</td>
                <td className="paramname"><span className="paramname"><span className="em">data</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">data\_str</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Create a job which will run asynchronously. </p>
      <p>(async) </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="#afcc40cdc8d8e8e4e2a5a1059354623e6">getJob</a>.</p>

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

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

            <tr>
              <td className="paramname">request\_encoding</td>

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

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a118390a860f5844472b2c2dac4bf20dd">BINARY</a> </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a28c36de3f25fc42dbba52af73e28df00">JSON</a> </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#af2addd7006fe60f9b04e645bd97c323c">SNAPPY</a> </li>
                </ul>

                The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a118390a860f5844472b2c2dac4bf20dd">BINARY</a>.
              </td>
            </tr>

            <tr>
              <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">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">request\_encoding</span> must be <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a118390a860f5844472b2c2dac4bf20dd">BINARY</a> or <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#af2addd7006fe60f9b04e645bd97c323c">SNAPPY</a>.</td>
            </tr>

            <tr>
              <td className="paramname">data\_str</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">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">request\_encoding</span> must be <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1RequestEncoding#a28c36de3f25fc42dbba52af73e28df00">JSON</a>.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateJobRequest_1_1Options#a9bf2eba2c7d5556cd540fd16270ad2f3">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 Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L21004">21004</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>