gpudb::ShowProcStatusRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/show_proc_status.h>

Public Member Functions
	ShowProcStatusRequest ()
	Constructs a ShowProcStatusRequest object with default parameter values. More...
	ShowProcStatusRequest (const std::string &runId_, const std::map< std::string, std::string > &options_)
	Constructs a ShowProcStatusRequest object with the specified parameters. More...

Public Attributes
std::string	runId
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from const) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Definition at line 22 of file show_proc_status.h.

Constructor & Destructor Documentation

gpudb::ShowProcStatusRequest::ShowProcStatusRequest ( )

inline

Constructs a ShowProcStatusRequest object with default parameter values.

Definition at line 29 of file show_proc_status.h.

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

inline

Constructs a ShowProcStatusRequest object with the specified parameters.

Parameters

[in]	runId_	The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned.
[in]	options_	Optional parameters. gpudb::show_proc_status_clear_complete: If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. gpudb::show_proc_status_true gpudb::show_proc_status_false The default value is gpudb::show_proc_status_false. gpudb::show_proc_status_run_tag: If runId is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to /execute/proc. The default value is ''.

Definition at line 69 of file show_proc_status.h.

Member Data Documentation

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

Definition at line 76 of file show_proc_status.h.

std::string gpudb::ShowProcStatusRequest::runId

Definition at line 75 of file show_proc_status.h.

---

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

• gpudb/protocol/show_proc_status.h