A set of parameters for GPUdb::adminAlterJobs. More...

#include <gpudb/protocol/admin_alter_jobs.h>

Public Member Functions
	AdminAlterJobsRequest ()
	Constructs an AdminAlterJobsRequest object with default parameters. More...

	AdminAlterJobsRequest (const std::vector< int64_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< int64_t >	jobIds
	Jobs to be modified. More...

std::string	action
	Action to be performed on the jobs specified by job_ids. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::adminAlterJobs.

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

Definition at line 28 of file admin_alter_jobs.h.

◆ AdminAlterJobsRequest() [2/2]

gpudb::AdminAlterJobsRequest::AdminAlterJobsRequest	(	const std::vector< int64_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. Supported values: admin_alter_jobs_cancel
[in]	options_	Optional parameters. admin_alter_jobs_job_tag: Job tag returned in call to create the job The default value is an empty map.

Definition at line 55 of file admin_alter_jobs.h.

Member Data Documentation

◆ action

std::string gpudb::AdminAlterJobsRequest::action

Action to be performed on the jobs specified by job_ids.

Supported values:

admin_alter_jobs_cancel

Definition at line 75 of file admin_alter_jobs.h.

◆ jobIds

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

Jobs to be modified.

Definition at line 65 of file admin_alter_jobs.h.

◆ options

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

Optional parameters.

admin_alter_jobs_job_tag: Job tag returned in call to create the job

The default value is an empty map.

Definition at line 86 of file admin_alter_jobs.h.

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

gpudb/protocol/admin_alter_jobs.h

Public Member Functions

Public Attributes