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

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

#include <gpudb/protocol/admin_show_alerts.h>

Public Member Functions

 AdminShowAlertsRequest ()
 Constructs an AdminShowAlertsRequest object with default parameters. 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
 Number of most recent alerts to request. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::adminShowAlerts.

Requests a list of the most recent alerts. Returns lists of alert data, including timestamp and type.

Definition at line 19 of file admin_show_alerts.h.

Constructor & Destructor Documentation

◆ AdminShowAlertsRequest() [1/2]

gpudb::AdminShowAlertsRequest::AdminShowAlertsRequest ( )
inline

Constructs an AdminShowAlertsRequest object with default parameters.

Definition at line 24 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 include up to numAlerts_ depending on how many alerts there are in the system. A value of 0 returns all stored alerts.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 42 of file admin_show_alerts.h.

Member Data Documentation

◆ numAlerts

int32_t gpudb::AdminShowAlertsRequest::numAlerts

Number of most recent alerts to request.

The response will include up to numAlerts depending on how many alerts there are in the system. A value of 0 returns all stored alerts.

Definition at line 53 of file admin_show_alerts.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 58 of file admin_show_alerts.h.


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