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

#include <gpudb/protocol/show_proc_status.h>

Public Member Functions
	ShowProcStatusRequest ()
	Constructs a ShowProcStatusRequest object with default parameters. 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
	The run ID of a specific proc instance for which the status will be returned. More...

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

Detailed Description

A set of parameters for GPUdb::showProcStatus.

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

Definition at line 27 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 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. The default value is ''.
[in]	options_	Optional parameters. 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. Supported values: show_proc_status_true show_proc_status_false The default value is show_proc_status_false. 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 GPUdb::executeProc. If runId_ is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb::executeProc. The default value is ''. The default value is an empty map.

Definition at line 83 of file show_proc_status.h.

Member Data Documentation

◆ options

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

Optional parameters.

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. Supported values:
- show_proc_status_true
- show_proc_status_false
The default value is show_proc_status_false.
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 GPUdb::executeProc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb::executeProc. The default value is ''.

The default value is an empty map.

Definition at line 128 of file show_proc_status.h.

◆ runId

std::string gpudb::ShowProcStatusRequest::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. The default value is ''.

Definition at line 95 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