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

> gpudb::AdminAlterJobsRequest — 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#af95f74ccf4ec9a3810077befea1e6e86">GPUdb::adminAlterJobs</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">gpudb/protocol/admin\_alter\_jobs.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:aa2db8afee8ad2bb2fde86de5c44a76e5" id="r_aa2db8afee8ad2bb2fde86de5c44a76e5">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa2db8afee8ad2bb2fde86de5c44a76e5">AdminAlterJobsRequest</a> ()</td>
      </tr>

      <tr className="memdesc:aa2db8afee8ad2bb2fde86de5c44a76e5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterJobsRequest" title="A set of parameters for GPUdb::adminAlterJobs.">AdminAlterJobsRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a2ea53eded71bdf8b816ec2363443bcd5" id="r_a2ea53eded71bdf8b816ec2363443bcd5">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2ea53eded71bdf8b816ec2363443bcd5">AdminAlterJobsRequest</a> (const std::vector\< int64\_t > \&jobIds\_, const std::string \&action\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a2ea53eded71bdf8b816ec2363443bcd5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterJobsRequest" title="A set of parameters for GPUdb::adminAlterJobs.">AdminAlterJobsRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a2ea53eded71bdf8b816ec2363443bcd5">
        <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:ac2d2324e3224fa2e3b126e517b16aa3a" id="r_ac2d2324e3224fa2e3b126e517b16aa3a">
        <td className="memItemLeft" align="right" valign="top">std::vector\< int64\_t > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac2d2324e3224fa2e3b126e517b16aa3a">jobIds</a></td>
      </tr>

      <tr className="memdesc:ac2d2324e3224fa2e3b126e517b16aa3a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Jobs to be modified. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a37d6755622225406e724650d1a99f507">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Action to be performed on the jobs specified by job\_ids. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a7b72c5ac00271c19ac7bb458520c2c0a">
        <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#af95f74ccf4ec9a3810077befea1e6e86">GPUdb::adminAlterJobs</a>. </p>
      <p>Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See <a href="/content/admin/job_manager/" target="_top">Job Manager</a> for more information. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source#l00023">23</a> of file <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">admin\_alter\_jobs.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aa2db8afee8ad2bb2fde86de5c44a76e5">◆ </a></span>AdminAlterJobsRequest() <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::AdminAlterJobsRequest::AdminAlterJobsRequest </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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterJobsRequest" title="A set of parameters for GPUdb::adminAlterJobs.">AdminAlterJobsRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source#l00028">28</a> of file <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">admin\_alter\_jobs.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a2ea53eded71bdf8b816ec2363443bcd5">◆ </a></span>AdminAlterJobsRequest() <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::AdminAlterJobsRequest::AdminAlterJobsRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::vector\< int64\_t > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">jobIds\_</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">action\_</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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterJobsRequest" title="A set of parameters for GPUdb::adminAlterJobs.">AdminAlterJobsRequest</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">jobIds\_</td>
                <td>Jobs to be modified. </td>
              </tr>

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

                <td>
                  Action to be performed on the jobs specified by job\_ids. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a65c6972ef975ae9442aab91a435e7485">admin\_alter\_jobs\_cancel</a> </li>
                  </ul>
                </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#a72711973455dc32381a65161aa98b08d">admin\_alter\_jobs\_job\_tag</a>: Job tag returned in call to create the job. </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/admin__alter__jobs_8h_source#l00055">55</a> of file <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">admin\_alter\_jobs.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Action to be performed on the jobs specified by job\_ids. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a65c6972ef975ae9442aab91a435e7485">admin\_alter\_jobs\_cancel</a> </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source#l00075">75</a> of file <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">admin\_alter\_jobs.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac2d2324e3224fa2e3b126e517b16aa3a">◆ </a></span>jobIds</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<int64\_t> gpudb::AdminAlterJobsRequest::jobIds</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Jobs to be modified. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source#l00065">65</a> of file <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">admin\_alter\_jobs.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a72711973455dc32381a65161aa98b08d">admin\_alter\_jobs\_job\_tag</a>: Job tag returned in call to create the job. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source#l00086">86</a> of file <a className="el" href="/content/api/cpp/admin__alter__jobs_8h_source">admin\_alter\_jobs.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/admin__alter__jobs_8h_source">admin\_alter\_jobs.h</a></li>
    </ul>
  </div>
</div>