redfish_codegen/registries/task_event/
v1_0_3.rs

1// Generated by redfish-codegen. Do not modify.
2
3use redfish_macros::IntoRedfishMessage;
4
5/// This registry defines the messages for task related events.
6#[derive(Clone, Debug, IntoRedfishMessage)]
7#[message(crate::models::message::v1_1_2::Message)]
8pub enum TaskEvent {
9    /// This message shall be used to indicate that a task has started as the `TaskState` property transitions to `Starting` or `Running`.
10    #[message(message = "The task with Id '%1' has started.")]
11    #[message(id = "TaskEvent.1.0.3.TaskStarted")]
12    #[message(severity = "crate::models::resource::Health::OK")]
13    #[message(resolution = "None.")]
14    TaskStarted(
15        /// This argument shall contain the value of the `Id` property of the task resource that has started.
16        String,
17    ),
18    /// This message shall be used to indicate that a task has completed with errors and the `TaskState` property transitioned to `Exception`.
19    #[message(message = "The task with Id '%1' has completed with errors.")]
20    #[message(id = "TaskEvent.1.0.3.TaskAborted")]
21    #[message(severity = "crate::models::resource::Health::Critical")]
22    #[message(resolution = "None.")]
23    TaskAborted(
24        /// This argument shall contain the value of the `Id` property of the task resource that has completed with errors.
25        String,
26    ),
27    /// This message shall be used to indicate that a task has completed and the `TaskState` property transitioned to `Completed`.
28    #[message(message = "The task with Id '%1' has completed.")]
29    #[message(id = "TaskEvent.1.0.3.TaskCompletedOK")]
30    #[message(severity = "crate::models::resource::Health::OK")]
31    #[message(resolution = "None.")]
32    TaskCompletedOK(
33        /// This argument shall contain the value of the `Id` property of the task resource that has completed.
34        String,
35    ),
36    /// This message shall be used to indicate that a task has been paused and the `TaskState` property transitioned to `Suspended` or `Interrupted`.
37    #[message(message = "The task with Id '%1' has been paused.")]
38    #[message(id = "TaskEvent.1.0.3.TaskPaused")]
39    #[message(severity = "crate::models::resource::Health::Warning")]
40    #[message(resolution = "None.")]
41    TaskPaused(
42        /// This argument shall contain the value of the `Id` property of the task resource that has been paused.
43        String,
44    ),
45    /// This message shall be used to indicate that work on a task has halted prior to completion due to an explicit request.  The `TaskState` property transitioned to `Cancelled`.
46    #[message(message = "Work on the task with Id '%1' has been halted prior to completion due to an explicit request.")]
47    #[message(id = "TaskEvent.1.0.3.TaskCancelled")]
48    #[message(severity = "crate::models::resource::Health::Warning")]
49    #[message(resolution = "None.")]
50    TaskCancelled(
51        /// This argument shall contain the value of the `Id` property of the task resource that has been halted.
52        String,
53    ),
54    /// This message shall be used to indicate that a task has completed with warnings and the `TaskState` property transitioned to `Completed`.
55    #[message(message = "The task with Id '%1' has completed with warnings.")]
56    #[message(id = "TaskEvent.1.0.3.TaskCompletedWarning")]
57    #[message(severity = "crate::models::resource::Health::Warning")]
58    #[message(resolution = "None.")]
59    TaskCompletedWarning(
60        /// This argument shall contain the value of the `Id` property of the task resource that has completed with warnings.
61        String,
62    ),
63    /// This message shall be used to indicate that a task has been removed.
64    #[message(message = "The task with Id '%1' has been removed.")]
65    #[message(id = "TaskEvent.1.0.3.TaskRemoved")]
66    #[message(severity = "crate::models::resource::Health::Warning")]
67    #[message(resolution = "None.")]
68    TaskRemoved(
69        /// This argument shall contain the value of the `Id` property of the task resource that has been removed.
70        String,
71    ),
72    /// This message shall be used to indicate that a task has resumed and the `TaskState` property transitioned to `Running` from `Suspended` or `Interrupted`.
73    #[message(message = "The task with Id '%1' has been resumed.")]
74    #[message(id = "TaskEvent.1.0.3.TaskResumed")]
75    #[message(severity = "crate::models::resource::Health::OK")]
76    #[message(resolution = "None.")]
77    TaskResumed(
78        /// This argument shall contain the value of the `Id` property of the task resource that has been resumed.
79        String,
80    ),
81    /// This message shall be used to indicate that a task has changed progress.
82    #[message(message = "The task with Id '%1' has changed to progress %2 percent complete.")]
83    #[message(id = "TaskEvent.1.0.3.TaskProgressChanged")]
84    #[message(severity = "crate::models::resource::Health::OK")]
85    #[message(resolution = "None.")]
86    TaskProgressChanged(
87        /// This argument shall contain the value of the `Id` property of the task resource that has changed progress.
88        String,
89        /// This argument shall contain the percent completion of the task that has changed progress.
90        f64,
91    ),
92}
redfish_codegen/registries/task_event/v1_0_3.rs

redfish_codegen/registries/task_event/
v1_0_3.rs
