xref: /openbmc/bmcweb/features/redfish/include/registries/heartbeat_event_message_registry.hpp (revision 4a102cd48c588d32c0a4d6610b4a9ed616f255f3)
1 // SPDX-License-Identifier: Apache-2.0
2 // SPDX-FileCopyrightText: Copyright OpenBMC Authors
3 #pragma once
4 /****************************************************************
5  *                 READ THIS WARNING FIRST
6  * This is an auto-generated header which contains definitions
7  * for Redfish DMTF defined messages.
8  * DO NOT modify this registry outside of running the
9  * parse_registries.py script.  The definitions contained within
10  * this file are owned by DMTF.  Any modifications to these files
11  * should be first pushed to the relevant registry in the DMTF
12  * github organization.
13  ***************************************************************/
14 #include "registries.hpp"
15 
16 #include <array>
17 
18 // clang-format off
19 
20 namespace redfish::registries
21 {
22 struct HeartbeatEvent
23 {
24 static constexpr Header header = {
25     "Copyright 2021-2023 DMTF. All rights reserved.",
26     "#MessageRegistry.v1_6_2.MessageRegistry",
27     1,
28     0,
29     1,
30     "Heartbeat Event Message Registry",
31     "en",
32     "This registry defines the messages to use for periodic heartbeat, also known as 'keep alive', events.",
33     "HeartbeatEvent",
34     "DMTF",
35 };
36 
37 static constexpr const char* url =
38     "https://redfish.dmtf.org/registries/HeartbeatEvent.1.0.1.json";
39 
40 static constexpr std::array registry =
41 {
42     MessageEntry{
43         "RedfishServiceFunctional",
44         {
45             "An event sent periodically upon request to indicates that the Redfish service is functional.",
46             "Redfish service is functional.",
47             "OK",
48             0,
49             {},
50             "None.",
51         }},
52 
53 };
54 
55 enum class Index
56 {
57     redfishServiceFunctional = 0,
58 };
59 }; // struct heartbeat_event
60 
61 [[gnu::constructor]] inline void registerHeartbeatEvent()
62 { registerRegistry<HeartbeatEvent>(); }
63 
64 } // namespace redfish::registries
65