> ## 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::GetJobResponse

> gpudb::GetJobResponse — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of results returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a0ff78cb10848a739067c5dbd0a052e05">GPUdb::getJob</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/get__job_8h_source">gpudb/protocol/get\_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:a1f8f5208b8c3be4347b71ecdb0218d18" id="r_a1f8f5208b8c3be4347b71ecdb0218d18">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a1f8f5208b8c3be4347b71ecdb0218d18">GetJobResponse</a> ()</td>
      </tr>

      <tr className="memdesc:a1f8f5208b8c3be4347b71ecdb0218d18">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetJobResponse" title="A set of results returned by GPUdb::getJob.">GetJobResponse</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a1f8f5208b8c3be4347b71ecdb0218d18">
        <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:a337001b48f539b011a4be511d766f194" id="r_a337001b48f539b011a4be511d766f194">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a337001b48f539b011a4be511d766f194">endpoint</a></td>
      </tr>

      <tr className="memdesc:a337001b48f539b011a4be511d766f194">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The endpoint which is being executed asynchronously. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a4110244ae2b0612cc4e3446f602a4d37">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Status of the submitted job. <br /></td>
      </tr>

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

      <tr className="memitem:abb061869914a14701dbc7cf65215ac88" id="r_abb061869914a14701dbc7cf65215ac88">
        <td className="memItemLeft" align="right" valign="top">bool </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#abb061869914a14701dbc7cf65215ac88">running</a></td>
      </tr>

      <tr className="memdesc:abb061869914a14701dbc7cf65215ac88">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">True if the end point is still executing. <br /></td>
      </tr>

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

      <tr className="memitem:a8e76fbc81e3877930f5f0af6b21fda5c" id="r_a8e76fbc81e3877930f5f0af6b21fda5c">
        <td className="memItemLeft" align="right" valign="top">int32\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8e76fbc81e3877930f5f0af6b21fda5c">progress</a></td>
      </tr>

      <tr className="memdesc:a8e76fbc81e3877930f5f0af6b21fda5c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Approximate percentage of the job completed. <br /></td>
      </tr>

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

      <tr className="memitem:a4baf5c180e88d883037dc4a27334f939" id="r_a4baf5c180e88d883037dc4a27334f939">
        <td className="memItemLeft" align="right" valign="top">bool </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4baf5c180e88d883037dc4a27334f939">successful</a></td>
      </tr>

      <tr className="memdesc:a4baf5c180e88d883037dc4a27334f939">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">True if the job execution completed and no errors were encountered. <br /></td>
      </tr>

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

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

      <tr className="memdesc:af6e9bd5bf953e4b111ba6086321c85c8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The encoding of the job result (contained in <a className="el" href="#a39b951804b1ef9f9a618daed10278980">jobResponse</a> or <a className="el" href="#ab4c082230bf8d0162457b5b3a6482482">jobResponseStr</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a39b951804b1ef9f9a618daed10278980">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The binary-encoded response of the job. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ab4c082230bf8d0162457b5b3a6482482">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The json-encoded response of the job. <br /></td>
      </tr>

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

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

      <tr className="memdesc:aae60dcd360a1426759c70160eb8be3ea">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Map of various status strings for the executed job. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a3187abe87b89fb9a30d2d452e337c6d7">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Additional information. <br /></td>
      </tr>

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

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

    <div className="textblock">
      <p>A set of results returned 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/get__job_8h_source#l00116">116</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a1f8f5208b8c3be4347b71ecdb0218d18">◆ </a></span>GetJobResponse()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::GetJobResponse::GetJobResponse </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_1GetJobResponse" title="A set of results returned by GPUdb::getJob.">GetJobResponse</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00121">121</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>The endpoint which is being executed asynchronously. </p>
        <p>E.g. '/alter/table'. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00139">139</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a3187abe87b89fb9a30d2d452e337c6d7">◆ </a></span>info</h2>

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

      <div className="memdoc">
        <p>Additional information. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00216">216</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a39b951804b1ef9f9a618daed10278980">◆ </a></span>jobResponse</h2>

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

      <div className="memdoc">
        <p>The binary-encoded response of the job. </p>
        <p>This field is populated only when the job has completed and <a className="el" href="#af6e9bd5bf953e4b111ba6086321c85c8">responseEncoding</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a734518bb6b7d82b2e584251421160eb8">binary</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00193">193</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab4c082230bf8d0162457b5b3a6482482">◆ </a></span>jobResponseStr</h2>

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

      <div className="memdoc">
        <p>The json-encoded response of the job. </p>
        <p>This field is populated only when the job has completed and <a className="el" href="#af6e9bd5bf953e4b111ba6086321c85c8">responseEncoding</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a618dd1c90a9728edfbe66b9d10616a4a">json</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00200">200</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4110244ae2b0612cc4e3446f602a4d37">◆ </a></span>jobStatus</h2>

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

      <div className="memdoc">
        <p>Status of the submitted job. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9ab4b7cc24d30cf17efdc9114e4a13d7">get\_job\_RUNNING</a>: The job is currently executing. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9fda54fe2b5e82abd8af7a16ba6e240b">get\_job\_DONE</a>: The job execution has successfully completed and the response is included in the <a className="el" href="#a39b951804b1ef9f9a618daed10278980">jobResponse</a> or <a className="el" href="#ab4c082230bf8d0162457b5b3a6482482">jobResponseStr</a> field. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a71437bb768c52dccb1b33620ee3d9de9">get\_job\_ERROR</a>: The job was attempted, but an error was encountered. The <a className="el" href="#aae60dcd360a1426759c70160eb8be3ea">statusMap</a> contains the details of the error in error\_message. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0a9e05f179313a5729c070e09df66b56">get\_job\_CANCELLED</a>: Job cancellation was requested while the execution was in progress. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00158">158</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8e76fbc81e3877930f5f0af6b21fda5c">◆ </a></span>progress</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int32\_t gpudb::GetJobResponse::progress</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Approximate percentage of the job completed. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00168">168</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af6e9bd5bf953e4b111ba6086321c85c8">◆ </a></span>responseEncoding</h2>

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

      <div className="memdoc">
        <p>The encoding of the job result (contained in <a className="el" href="#a39b951804b1ef9f9a618daed10278980">jobResponse</a> or <a className="el" href="#ab4c082230bf8d0162457b5b3a6482482">jobResponseStr</a>. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a734518bb6b7d82b2e584251421160eb8">get\_job\_binary</a>: The job result is binary-encoded. It is contained in <a className="el" href="#a39b951804b1ef9f9a618daed10278980">jobResponse</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a618dd1c90a9728edfbe66b9d10616a4a">get\_job\_json</a>: The job result is JSON-encoded. It is contained in <a className="el" href="#ab4c082230bf8d0162457b5b3a6482482">jobResponseStr</a>. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00186">186</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#abb061869914a14701dbc7cf65215ac88">◆ </a></span>running</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">bool gpudb::GetJobResponse::running</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>True if the end point is still executing. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00163">163</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aae60dcd360a1426759c70160eb8be3ea">◆ </a></span>statusMap</h2>

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

      <div className="memdoc">
        <p>Map of various status strings for the executed job. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa3a5d452553564fc75063a6ccff90eae">get\_job\_error\_message</a>: Explains what error occurred while running the job asynchronously. This entry only exists when the job status is <a className="el" href="/content/api/cpp/namespacegpudb#a71437bb768c52dccb1b33620ee3d9de9">ERROR</a>. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00211">211</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_job.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4baf5c180e88d883037dc4a27334f939">◆ </a></span>successful</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">bool gpudb::GetJobResponse::successful</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>True if the job execution completed and no errors were encountered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__job_8h_source#l00173">173</a> of file <a className="el" href="/content/api/cpp/get__job_8h_source">get\_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/get__job_8h_source">get\_job.h</a></li>
    </ul>
  </div>
</div>