xref: /openbmc/bmcweb/features/redfish/include/registries/task_event_message_registry.hpp (revision fc8a2b87a8d5daf67ece24b0b259e507b3442bd7) 
1 /*
2 // Copyright (c) 2020 Intel Corporation
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 */
16 /****************************************************************
17  * This is an auto-generated header which contains definitions
18  * for Redfish DMTF defined messages.
19  ***************************************************************/
20 #pragma once
21 #include <registries.hpp>
22 
23 namespace redfish::message_registries::task_event
24 {
25 const Header header = {
26     "Copyright 2014-2020 DMTF in cooperation with the Storage Networking "
27     "Industry Association (SNIA). All rights reserved.",
28     "#MessageRegistry.v1_4_1.MessageRegistry",
29     "TaskEvent.1.0.3",
30     "Task Event Message Registry",
31     "en",
32     "This registry defines the messages for task related events.",
33     "TaskEvent",
34     "1.0.3",
35     "DMTF",
36 };
37 constexpr const char* url =
38     "https://redfish.dmtf.org/registries/TaskEvent.1.0.3.json";
39 
40 constexpr std::array<MessageEntry, 9> registry = {
41     MessageEntry{"TaskAborted",
42                  {
43                      "A task has completed with errors.",
44                      "The task with Id '%1' has completed with errors.",
45                      "Critical",
46                      "Critical",
47                      1,
48                      {
49                          "string",
50                      },
51                      "None.",
52                  }},
53     MessageEntry{"TaskCancelled",
54                  {
55                      "A task has been cancelled.",
56                      "Work on the task with Id '%1' has been halted prior to "
57                      "completion due to an explicit request.",
58                      "Warning",
59                      "Warning",
60                      1,
61                      {
62                          "string",
63                      },
64                      "None.",
65                  }},
66     MessageEntry{"TaskCompletedOK",
67                  {
68                      "A task has completed.",
69                      "The task with Id '%1' has completed.",
70                      "OK",
71                      "OK",
72                      1,
73                      {
74                          "string",
75                      },
76                      "None.",
77                  }},
78     MessageEntry{"TaskCompletedWarning",
79                  {
80                      "A task has completed with warnings.",
81                      "The task with Id '%1' has completed with warnings.",
82                      "Warning",
83                      "Warning",
84                      1,
85                      {
86                          "string",
87                      },
88                      "None.",
89                  }},
90     MessageEntry{"TaskPaused",
91                  {
92                      "A task has been paused.",
93                      "The task with Id '%1' has been paused.",
94                      "Warning",
95                      "Warning",
96                      1,
97                      {
98                          "string",
99                      },
100                      "None.",
101                  }},
102     MessageEntry{"TaskProgressChanged",
103                  {
104                      "A task has changed progress.",
105                      "The task with Id '%1' has changed to progress %2 percent "
106                      "complete.",
107                      "OK",
108                      "OK",
109                      2,
110                      {
111                          "string",
112                          "number",
113                      },
114                      "None.",
115                  }},
116     MessageEntry{"TaskRemoved",
117                  {
118                      "A task has been removed.",
119                      "The task with Id '%1' has been removed.",
120                      "Warning",
121                      "Warning",
122                      1,
123                      {
124                          "string",
125                      },
126                      "None.",
127                  }},
128     MessageEntry{"TaskResumed",
129                  {
130                      "A task has been resumed.",
131                      "The task with Id '%1' has been resumed.",
132                      "OK",
133                      "OK",
134                      1,
135                      {
136                          "string",
137                      },
138                      "None.",
139                  }},
140     MessageEntry{"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 } // namespace redfish::message_registries::task_event
154