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