Process-level HTTP POST settings for status report uploads. More...
#include <ConfigurationObjects.h>
Inherits AppConfigurationObjects::ConfigurationObjectBase.
Public Attributes | |
| std::string | baseUrl |
| int | timeoutSecs |
 Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| nlohmann::json | _attached |
| std::string | apiKey |
| Tls | tls |
| void | clear () |
Additional Inherited Members | |
| Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| virtual void | initForDocumenting () |
| virtual std::string | toString () |
| virtual bool | isDocumenting () const |
| Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| bool | _documenting |
Detailed Description
Process-level HTTP POST settings for status report uploads.
When baseUrl is non-empty, producers POST status JSON to {baseUrl}/{kind} where kind is a fixed product constant (see ENGAGE_STATUS_REPORT_KIND_* in EngageConstants.h). Supports ${id} and ${instance} placeholder expansion in baseUrl (applied by each product at configuration load).
Definition at line 10023 of file ConfigurationObjects.h.
Constructor & Destructor Documentation
◆ StatusUploadConfiguration()
|
inline |
Definition at line 10048 of file ConfigurationObjects.h.
Member Function Documentation
◆ clear()
|
inline |
Definition at line 10053 of file ConfigurationObjects.h.
Member Data Documentation
◆ apiKey
| std::string AppConfigurationObjects::StatusUploadConfiguration::apiKey |
[Optional] Sent as X-Engage-Api-Key on each POST when non-empty. Supports $ENV} expansion at configuration load (same as baseUrl).
Definition at line 10039 of file ConfigurationObjects.h.
◆ baseUrl
| std::string AppConfigurationObjects::StatusUploadConfiguration::baseUrl |
[Optional, Default: ""] Base http(s) URL; empty disables POST upload.
Definition at line 10030 of file ConfigurationObjects.h.
◆ timeoutSecs
| int AppConfigurationObjects::StatusUploadConfiguration::timeoutSecs |
[Optional, Default: 3] POST timeout in seconds (clamped to 1..30).
Definition at line 10033 of file ConfigurationObjects.h.
◆ tls
| Tls AppConfigurationObjects::StatusUploadConfiguration::tls |
[Optional] TLS policy for https:// uploads. Defaults match UrlRetriever (verifyPeers true, self-signed not allowed). Lab collectors with a generated self-signed cert should set allowSelfSignedCertificates.
Definition at line 10046 of file ConfigurationObjects.h.
The documentation for this class was generated from the following file:
- engage/src/api/c/include/ConfigurationObjects.h
