GPUdb C++ API  Version 6.2.0.3
gpudb::KillProcRequest Struct Reference

A set of input parameters for killProc(const KillProcRequest&) const. More...

#include <gpudb/protocol/kill_proc.h>

Public Member Functions

 KillProcRequest ()
 Constructs a KillProcRequest object with default parameter values. More...
 
 KillProcRequest (const std::string &runId_, const std::map< std::string, std::string > &options_)
 Constructs a KillProcRequest 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 killProc(const KillProcRequest&) const.

Kills a running proc instance.

Definition at line 18 of file kill_proc.h.

Constructor & Destructor Documentation

◆ KillProcRequest() [1/2]

gpudb::KillProcRequest::KillProcRequest ( )
inline

Constructs a KillProcRequest object with default parameter values.

Definition at line 24 of file kill_proc.h.

◆ KillProcRequest() [2/2]

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

Constructs a KillProcRequest object with the specified parameters.

Parameters
[in]runId_The run ID of the running proc instance. If the run ID is not found or the proc instance has already completed, this does nothing. If not specified, all running proc instances will be killed.
[in]options_Optional parameters.

Definition at line 41 of file kill_proc.h.

Member Data Documentation

◆ options

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

Definition at line 48 of file kill_proc.h.

◆ runId

std::string gpudb::KillProcRequest::runId

Definition at line 47 of file kill_proc.h.


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