GPUdb C++ API  Version 7.2.2.4
gpudb::ShowTableMonitorsRequest Struct Reference

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

#include <gpudb/protocol/show_table_monitors.h>

Public Member Functions

 ShowTableMonitorsRequest ()
 Constructs a ShowTableMonitorsRequest object with default parameters. More...
 
 ShowTableMonitorsRequest (const std::vector< std::string > &monitorIds_, const std::map< std::string, std::string > &options_)
 Constructs a ShowTableMonitorsRequest object with the specified parameters. More...
 

Public Attributes

std::vector< std::string > monitorIds
 List of monitors to be shown. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showTableMonitors.

Show table monitors and their properties. Table monitors are created using GPUdb::createTableMonitor. Returns detailed information about existing table monitors.

Definition at line 22 of file show_table_monitors.h.

Constructor & Destructor Documentation

◆ ShowTableMonitorsRequest() [1/2]

gpudb::ShowTableMonitorsRequest::ShowTableMonitorsRequest ( )
inline

Constructs a ShowTableMonitorsRequest object with default parameters.

Definition at line 28 of file show_table_monitors.h.

◆ ShowTableMonitorsRequest() [2/2]

gpudb::ShowTableMonitorsRequest::ShowTableMonitorsRequest ( const std::vector< std::string > &  monitorIds_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowTableMonitorsRequest object with the specified parameters.

Parameters
[in]monitorIds_List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 44 of file show_table_monitors.h.

Member Data Documentation

◆ monitorIds

std::vector<std::string> gpudb::ShowTableMonitorsRequest::monitorIds

List of monitors to be shown.

An empty list or a single entry with an empty string returns all table monitors.

Definition at line 54 of file show_table_monitors.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 59 of file show_table_monitors.h.


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