GPUdb C++ API  Version 6.2.0.3
gpudb::AdminAlterJobsRequest Struct Reference

A set of input parameters for adminAlterJobs(const AdminAlterJobsRequest&) const. More...

#include <gpudb/protocol/admin_alter_jobs.h>

Public Member Functions

 AdminAlterJobsRequest ()
 Constructs an AdminAlterJobsRequest object with default parameter values. More...
 
 AdminAlterJobsRequest (const std::vector< int32_t > &jobIds_, const std::string &action_, const std::map< std::string, std::string > &options_)
 Constructs an AdminAlterJobsRequest object with the specified parameters. More...
 

Public Attributes

std::vector< int32_t > jobIds
 
std::string action
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for adminAlterJobs(const AdminAlterJobsRequest&) const.

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 Job Manager for more information.

Definition at line 23 of file admin_alter_jobs.h.

Constructor & Destructor Documentation

◆ AdminAlterJobsRequest() [1/2]

gpudb::AdminAlterJobsRequest::AdminAlterJobsRequest ( )
inline

Constructs an AdminAlterJobsRequest object with default parameter values.

Definition at line 30 of file admin_alter_jobs.h.

◆ AdminAlterJobsRequest() [2/2]

gpudb::AdminAlterJobsRequest::AdminAlterJobsRequest ( const std::vector< int32_t > &  jobIds_,
const std::string &  action_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AdminAlterJobsRequest object with the specified parameters.

Parameters
[in]jobIds_Jobs to be modified.
[in]action_Action to be performed on the jobs specified by job_ids.
[in]options_Optional parameters.

Definition at line 50 of file admin_alter_jobs.h.

Member Data Documentation

◆ action

std::string gpudb::AdminAlterJobsRequest::action

Definition at line 58 of file admin_alter_jobs.h.

◆ jobIds

std::vector<int32_t> gpudb::AdminAlterJobsRequest::jobIds

Definition at line 57 of file admin_alter_jobs.h.

◆ options

std::map<std::string, std::string> gpudb::AdminAlterJobsRequest::options

Definition at line 59 of file admin_alter_jobs.h.


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