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

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

#include <gpudb/protocol/admin_send_alert.h>

Public Member Functions

 AdminSendAlertRequest ()
 Constructs an AdminSendAlertRequest object with default parameters. More...
 
 AdminSendAlertRequest (const std::string &message_, const std::string &label_, const std::string &logLevel_, const std::map< std::string, std::string > &options_)
 Constructs an AdminSendAlertRequest object with the specified parameters. More...
 

Public Attributes

std::string message
 Alert message body. More...
 
std::string label
 Label to add to alert message. More...
 
std::string logLevel
 Alert message logging criteria. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::adminSendAlert.

Sends a user generated alert to the monitoring system.

Definition at line 18 of file admin_send_alert.h.

Constructor & Destructor Documentation

◆ AdminSendAlertRequest() [1/2]

gpudb::AdminSendAlertRequest::AdminSendAlertRequest ( )
inline

Constructs an AdminSendAlertRequest object with default parameters.

Definition at line 23 of file admin_send_alert.h.

◆ AdminSendAlertRequest() [2/2]

gpudb::AdminSendAlertRequest::AdminSendAlertRequest ( const std::string &  message_,
const std::string &  label_,
const std::string &  logLevel_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AdminSendAlertRequest object with the specified parameters.

Parameters
[in]message_Alert message body. The default value is ''.
[in]label_Label to add to alert message. The default value is ''.
[in]logLevel_Alert message logging criteria. Supported values:
[in]options_Optional parameters. The default value is an empty map.

Definition at line 55 of file admin_send_alert.h.

Member Data Documentation

◆ label

std::string gpudb::AdminSendAlertRequest::label

Label to add to alert message.

The default value is ''.

Definition at line 71 of file admin_send_alert.h.

◆ logLevel

std::string gpudb::AdminSendAlertRequest::logLevel

Alert message logging criteria.

Supported values:

Definition at line 84 of file admin_send_alert.h.

◆ message

std::string gpudb::AdminSendAlertRequest::message

Alert message body.

The default value is ''.

Definition at line 66 of file admin_send_alert.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 89 of file admin_send_alert.h.


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