gpudb::AdminShowJobsRequest Struct Reference

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

#include <gpudb/protocol/admin_show_jobs.h>

Public Member Functions
	AdminShowJobsRequest ()
	Constructs an AdminShowJobsRequest object with default parameters. More...
	AdminShowJobsRequest (const std::map< std::string, std::string > &options_)
	Constructs an AdminShowJobsRequest object with the specified parameters. More...

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

Detailed Description

A set of parameters for GPUdb::adminShowJobs.

Get a list of the current jobs in GPUdb.

Definition at line 18 of file admin_show_jobs.h.

Constructor & Destructor Documentation

AdminShowJobsRequest() [1/2]

gpudb::AdminShowJobsRequest::AdminShowJobsRequest ( )

inline

Constructs an AdminShowJobsRequest object with default parameters.

Definition at line 23 of file admin_show_jobs.h.

AdminShowJobsRequest() [2/2]

gpudb::AdminShowJobsRequest::AdminShowJobsRequest ( const std::map< std::string, std::string > &  options_ )

inline

Constructs an AdminShowJobsRequest object with the specified parameters.

Parameters

[in]

options_

Optional parameters. admin_show_jobs_show_async_jobs: If true, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values: admin_show_jobs_true admin_show_jobs_false The default value is admin_show_jobs_false. admin_show_jobs_show_worker_info: If true, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values: admin_show_jobs_true admin_show_jobs_false The default value is an empty map.

Definition at line 75 of file admin_show_jobs.h.

Member Data Documentation

options

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

Optional parameters.

• admin_show_jobs_show_async_jobs: If true, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values:
  • admin_show_jobs_true
  • admin_show_jobs_false
  The default value is admin_show_jobs_false.
• admin_show_jobs_show_worker_info: If true, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
  • admin_show_jobs_true
  • admin_show_jobs_false

The default value is an empty map.

Definition at line 113 of file admin_show_jobs.h.

---

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

• gpudb/protocol/admin_show_jobs.h