GPUdb C++ API  Version 7.0.8.0
gpudb::ShowProcStatusRequest Struct Reference

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

Definition at line 69 of file show_proc_status.h.

Member Data Documentation

◆ options

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

Definition at line 76 of file show_proc_status.h.

◆ runId

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: