xref: /openbmc/bmcweb/redfish-core/include/registries/task_event_message_registry.hpp (revision 40e9b92ec19acffb46f83a6e55b18974da5d708e)
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::task_event
21 {
22 const Header header = {
23     "Copyright 2014-2020 DMTF in cooperation with the Storage Networking Industry Association (SNIA). All rights reserved.",
24     "#MessageRegistry.v1_4_1.MessageRegistry",
25     1,
26     0,
27     3,
28     "Task Event Message Registry",
29     "en",
30     "This registry defines the messages for task related events.",
31     "TaskEvent",
32     "DMTF",
33 };
34 constexpr const char* url =
35     "https://redfish.dmtf.org/registries/TaskEvent.1.0.3.json";
36 
37 constexpr std::array registry =
38 {
39     MessageEntry{
40         "TaskAborted",
41         {
42             "A task has completed with errors.",
43             "The task with Id '%1' has completed with errors.",
44             "Critical",
45             1,
46             {
47                 "string",
48             },
49             "None.",
50         }},
51     MessageEntry{
52         "TaskCancelled",
53         {
54             "A task has been cancelled.",
55             "Work on the task with Id '%1' has been halted prior to completion due to an explicit request.",
56             "Warning",
57             1,
58             {
59                 "string",
60             },
61             "None.",
62         }},
63     MessageEntry{
64         "TaskCompletedOK",
65         {
66             "A task has completed.",
67             "The task with Id '%1' has completed.",
68             "OK",
69             1,
70             {
71                 "string",
72             },
73             "None.",
74         }},
75     MessageEntry{
76         "TaskCompletedWarning",
77         {
78             "A task has completed with warnings.",
79             "The task with Id '%1' has completed with warnings.",
80             "Warning",
81             1,
82             {
83                 "string",
84             },
85             "None.",
86         }},
87     MessageEntry{
88         "TaskPaused",
89         {
90             "A task has been paused.",
91             "The task with Id '%1' has been paused.",
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             2,
106             {
107                 "string",
108                 "number",
109             },
110             "None.",
111         }},
112     MessageEntry{
113         "TaskRemoved",
114         {
115             "A task has been removed.",
116             "The task with Id '%1' has been removed.",
117             "Warning",
118             1,
119             {
120                 "string",
121             },
122             "None.",
123         }},
124     MessageEntry{
125         "TaskResumed",
126         {
127             "A task has been resumed.",
128             "The task with Id '%1' has been resumed.",
129             "OK",
130             1,
131             {
132                 "string",
133             },
134             "None.",
135         }},
136     MessageEntry{
137         "TaskStarted",
138         {
139             "A task has started.",
140             "The task with Id '%1' has started.",
141             "OK",
142             1,
143             {
144                 "string",
145             },
146             "None.",
147         }},
148 
149 };
150 
151 enum class Index
152 {
153     taskAborted = 0,
154     taskCancelled = 1,
155     taskCompletedOK = 2,
156     taskCompletedWarning = 3,
157     taskPaused = 4,
158     taskProgressChanged = 5,
159     taskRemoved = 6,
160     taskResumed = 7,
161     taskStarted = 8,
162 };
163 } // namespace redfish::registries::task_event
164