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