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

A set of input parameters for adminShowAlerts(const AdminShowAlertsRequest&) const. More...

#include <gpudb/protocol/admin_show_alerts.h>

Public Member Functions

 AdminShowAlertsRequest ()
 Constructs an AdminShowAlertsRequest object with default parameter values. More...
 
 AdminShowAlertsRequest (const int32_t numAlerts_, const std::map< std::string, std::string > &options_)
 Constructs an AdminShowAlertsRequest object with the specified parameters. More...
 

Public Attributes

int32_t numAlerts
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for adminShowAlerts(const AdminShowAlertsRequest&) const.

Retrieves a list of the most recent alerts generated. The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Definition at line 20 of file admin_show_alerts.h.

Constructor & Destructor Documentation

◆ AdminShowAlertsRequest() [1/2]

gpudb::AdminShowAlertsRequest::AdminShowAlertsRequest ( )
inline

Constructs an AdminShowAlertsRequest object with default parameter values.

Definition at line 27 of file admin_show_alerts.h.

◆ AdminShowAlertsRequest() [2/2]

gpudb::AdminShowAlertsRequest::AdminShowAlertsRequest ( const int32_t  numAlerts_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AdminShowAlertsRequest object with the specified parameters.

Parameters
[in]numAlerts_Number of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.
[in]options_Optional parameters.

Definition at line 44 of file admin_show_alerts.h.

Member Data Documentation

◆ numAlerts

int32_t gpudb::AdminShowAlertsRequest::numAlerts

Definition at line 50 of file admin_show_alerts.h.

◆ options

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

Definition at line 51 of file admin_show_alerts.h.


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