xref: /openbmc/bmcweb/features/redfish/include/registries/task_event_message_registry.hpp (revision 4a102cd48c588d32c0a4d6610b4a9ed616f255f3)

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors
#pragma once
/****************************************************************
 *                 READ THIS WARNING FIRST
 * This is an auto-generated header which contains definitions
 * for Redfish DMTF defined messages.
 * DO NOT modify this registry outside of running the
 * parse_registries.py script.  The definitions contained within
 * this file are owned by DMTF.  Any modifications to these files
 * should be first pushed to the relevant registry in the DMTF
 * github organization.
 ***************************************************************/
#include "registries.hpp"

#include <array>

// clang-format off

namespace redfish::registries
{
struct TaskEvent
{
static constexpr Header header = {
    "Copyright 2014-2020 DMTF in cooperation with the Storage Networking Industry Association (SNIA). All rights reserved.",
    "#MessageRegistry.v1_4_1.MessageRegistry",
    1,
    0,
    3,
    "Task Event Message Registry",
    "en",
    "This registry defines the messages for task related events.",
    "TaskEvent",
    "DMTF",
};

static constexpr const char* url =
    "https://redfish.dmtf.org/registries/TaskEvent.1.0.3.json";

static constexpr std::array registry =
{
    MessageEntry{
        "TaskAborted",
        {
            "A task has completed with errors.",
            "The task with Id '%1' has completed with errors.",
            "Critical",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskCancelled",
        {
            "A task has been cancelled.",
            "Work on the task with Id '%1' has been halted prior to completion due to an explicit request.",
            "Warning",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskCompletedOK",
        {
            "A task has completed.",
            "The task with Id '%1' has completed.",
            "OK",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskCompletedWarning",
        {
            "A task has completed with warnings.",
            "The task with Id '%1' has completed with warnings.",
            "Warning",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskPaused",
        {
            "A task has been paused.",
            "The task with Id '%1' has been paused.",
            "Warning",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskProgressChanged",
        {
            "A task has changed progress.",
            "The task with Id '%1' has changed to progress %2 percent complete.",
            "OK",
            2,
            {
                "string",
                "number",
            },
            "None.",
        }},
    MessageEntry{
        "TaskRemoved",
        {
            "A task has been removed.",
            "The task with Id '%1' has been removed.",
            "Warning",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskResumed",
        {
            "A task has been resumed.",
            "The task with Id '%1' has been resumed.",
            "OK",
            1,
            {
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "TaskStarted",
        {
            "A task has started.",
            "The task with Id '%1' has started.",
            "OK",
            1,
            {
                "string",
            },
            "None.",
        }},

};

enum class Index
{
    taskAborted = 0,
    taskCancelled = 1,
    taskCompletedOK = 2,
    taskCompletedWarning = 3,
    taskPaused = 4,
    taskProgressChanged = 5,
    taskRemoved = 6,
    taskResumed = 7,
    taskStarted = 8,
};
}; // struct task_event

[[gnu::constructor]] inline void registerTaskEvent()
{ registerRegistry<TaskEvent>(); }

} // namespace redfish::registries