xref: /openbmc/bmcweb/features/redfish/include/registries/task_event_message_registry.hpp (revision 1cf53df04bc2525776cf6fd212304c0857cd6a38)
1 /****************************************************************
2  *                 READ THIS WARNING FIRST
3  * This is an auto-generated header which contains definitions
4  * for Redfish DMTF defined messages.
5  * DO NOT modify this registry outside of running the
6  * parse_regisries.py script.  The definitions contained within
7  * this file are owned by DMTF.  Any modifications to these files
8  * should be first pushed to the relevant registry in the DMTF
9  * github organization.
10  ***************************************************************/
11 #pragma once
12 #include <registries.hpp>
13 
14 // clang-format off
15 
16 namespace redfish::message_registries::task_event
17 {
18 const Header header = {
19     "Copyright 2014-2020 DMTF in cooperation with the Storage Networking Industry Association (SNIA). All rights reserved.",
20     "#MessageRegistry.v1_4_1.MessageRegistry",
21     "TaskEvent.1.0.3",
22     "Task Event Message Registry",
23     "en",
24     "This registry defines the messages for task related events.",
25     "TaskEvent",
26     "1.0.3",
27     "DMTF",
28 };
29 constexpr const char* url =
30     "https://redfish.dmtf.org/registries/TaskEvent.1.0.3.json";
31 
32 constexpr std::array<MessageEntry, 9> registry =
33 {
34     MessageEntry{
35         "TaskAborted",
36         {
37             "A task has completed with errors.",
38             "The task with Id '%1' has completed with errors.",
39             "Critical",
40             "Critical",
41             1,
42             {
43                 "string",
44             },
45             "None.",
46         }},
47     MessageEntry{
48         "TaskCancelled",
49         {
50             "A task has been cancelled.",
51             "Work on the task with Id '%1' has been halted prior to completion due to an explicit request.",
52             "Warning",
53             "Warning",
54             1,
55             {
56                 "string",
57             },
58             "None.",
59         }},
60     MessageEntry{
61         "TaskCompletedOK",
62         {
63             "A task has completed.",
64             "The task with Id '%1' has completed.",
65             "OK",
66             "OK",
67             1,
68             {
69                 "string",
70             },
71             "None.",
72         }},
73     MessageEntry{
74         "TaskCompletedWarning",
75         {
76             "A task has completed with warnings.",
77             "The task with Id '%1' has completed with warnings.",
78             "Warning",
79             "Warning",
80             1,
81             {
82                 "string",
83             },
84             "None.",
85         }},
86     MessageEntry{
87         "TaskPaused",
88         {
89             "A task has been paused.",
90             "The task with Id '%1' has been paused.",
91             "Warning",
92             "Warning",
93             1,
94             {
95                 "string",
96             },
97             "None.",
98         }},
99     MessageEntry{
100         "TaskProgressChanged",
101         {
102             "A task has changed progress.",
103             "The task with Id '%1' has changed to progress %2 percent complete.",
104             "OK",
105             "OK",
106             2,
107             {
108                 "string",
109                 "number",
110             },
111             "None.",
112         }},
113     MessageEntry{
114         "TaskRemoved",
115         {
116             "A task has been removed.",
117             "The task with Id '%1' has been removed.",
118             "Warning",
119             "Warning",
120             1,
121             {
122                 "string",
123             },
124             "None.",
125         }},
126     MessageEntry{
127         "TaskResumed",
128         {
129             "A task has been resumed.",
130             "The task with Id '%1' has been resumed.",
131             "OK",
132             "OK",
133             1,
134             {
135                 "string",
136             },
137             "None.",
138         }},
139     MessageEntry{
140         "TaskStarted",
141         {
142             "A task has started.",
143             "The task with Id '%1' has started.",
144             "OK",
145             "OK",
146             1,
147             {
148                 "string",
149             },
150             "None.",
151         }},
152 
153 };
154 
155 enum class Index
156 {
157     taskAborted = 0,
158     taskCancelled = 1,
159     taskCompletedOK = 2,
160     taskCompletedWarning = 3,
161     taskPaused = 4,
162     taskProgressChanged = 5,
163     taskRemoved = 6,
164     taskResumed = 7,
165     taskStarted = 8,
166 };
167 } // namespace redfish::message_registries::task_event
168