A set of input parameters for showProcStatus(const ShowProcStatusRequest&) 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 showProcStatus(const ShowProcStatusRequest&) const.

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from executeProc(const ExecuteProcRequest&) 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

◆ ShowProcStatusRequest() [1/2]

gpudb::ShowProcStatusRequest::ShowProcStatusRequest ( )

inline

Constructs a ShowProcStatusRequest object with default parameter values.

Definition at line 29 of file show_proc_status.h.

◆ ShowProcStatusRequest() [2/2]

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 running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed 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.

Definition at line 62 of file show_proc_status.h.

Member Data Documentation

◆ options

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

Definition at line 69 of file show_proc_status.h.

◆ runId

std::string gpudb::ShowProcStatusRequest::runId

Definition at line 68 of file show_proc_status.h.

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

gpudb/protocol/show_proc_status.h

Public Member Functions