redfish_codegen/registries/sensor_event/
v1_0_0.rs

1// Generated by redfish-codegen. Do not modify.
2
3use redfish_macros::IntoRedfishMessage;
4
5/// This registry defines messages used for general events related to Sensor resources.
6#[derive(Clone, Debug, IntoRedfishMessage)]
7#[message(crate::models::message::v1_1_2::Message)]
8pub enum SensorEvent {
9    /// This message shall be used to indicate that the value of the `Reading` in a `Sensor` resource, previously below the threshold, is now above the value of the `Reading` property within the `LowerFatal` property.  However, the value of the `Reading` property is still below at least one `Reading` property of another lower threshold and is not within the normal operating range.
10    #[message(message = "Sensor '%1' reading of %2 (%3) is now above the %4 lower fatal threshold but remains outside of normal range.")]
11    #[message(id = "SensorEvent.1.0.0.ReadingAboveLowerFatalThreshold")]
12    #[message(severity = "crate::models::resource::Health::Critical")]
13    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
14    ReadingAboveLowerFatalThreshold(
15        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
16        String,
17        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
18        f64,
19        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
20        String,
21        /// This argument shall contain a number that equals the value of the `Reading` property within the `LowerFatal` property of the `Sensor` resource.
22        f64,
23    ),
24    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource is above the value of the `Reading` property within the `UpperFatal` property.
25    #[message(message = "Sensor '%1' reading of %2 (%3) is above the %4 upper fatal threshold.")]
26    #[message(id = "SensorEvent.1.0.0.ReadingAboveUpperFatalThreshold")]
27    #[message(severity = "crate::models::resource::Health::Critical")]
28    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
29    ReadingAboveUpperFatalThreshold(
30        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
31        String,
32        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
33        f64,
34        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
35        String,
36        /// This argument shall contain a number that equals the value of the `Reading` property within the `UpperFatal` property of the `Sensor` resource.
37        f64,
38    ),
39    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource exceeds the value of an internal critical level.  This message shall be used for `Sensor` resources that do not contain readable critical threshold values, such as boolean trip points or similiar hardware mechanisms.  This message shall not be used if the `Reading` property within a corresponding critical threshold is available.
40    #[message(message = "Sensor '%1' reading of %2 (%3) exceeds the critical level.")]
41    #[message(id = "SensorEvent.1.0.0.ReadingCritical")]
42    #[message(severity = "crate::models::resource::Health::Critical")]
43    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
44    ReadingCritical(
45        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
46        String,
47        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
48        f64,
49        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
50        String,
51    ),
52    /// This message shall be used to indicate that the service is unable to communicate with a sensor or has otherwise detected a fault condition with the sensor.
53    #[message(message = "Sensor '%1' has failed.")]
54    #[message(id = "SensorEvent.1.0.0.SensorFailure")]
55    #[message(severity = "crate::models::resource::Health::Warning")]
56    #[message(resolution = "Check the sensor hardware or connection.")]
57    SensorFailure(
58        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
59        String,
60    ),
61    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource is below the value of the `Reading` property within the `LowerCaution` or `LowerCautionUser` properties.
62    #[message(message = "Sensor '%1' reading of %2 (%3) is below the %4 lower caution threshold.")]
63    #[message(id = "SensorEvent.1.0.0.ReadingBelowLowerCautionThreshold")]
64    #[message(severity = "crate::models::resource::Health::Warning")]
65    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
66    ReadingBelowLowerCautionThreshold(
67        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
68        String,
69        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
70        f64,
71        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
72        String,
73        /// This argument shall contain a number that equals the value of the `Reading` property within the `LowerCaution` or `LowerCautionUser` properties of the `Sensor` resource.
74        f64,
75    ),
76    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource is below the value of the `Reading` property within the `LowerFatal` property.
77    #[message(message = "Sensor '%1' reading of %2 (%3) is below the %4 lower fatal threshold.")]
78    #[message(id = "SensorEvent.1.0.0.ReadingBelowLowerFatalThreshold")]
79    #[message(severity = "crate::models::resource::Health::Critical")]
80    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
81    ReadingBelowLowerFatalThreshold(
82        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
83        String,
84        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
85        f64,
86        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
87        String,
88        /// This argument shall contain a number that equals the value of the `Reading` property within the `LowerFatal` property of the `Sensor` resource.
89        f64,
90    ),
91    /// This message shall be used to indicate that the value of the `Reading` in a `Sensor` resource, previously above the threshold, is now below the value of the `Reading` property within the `UpperCritical` or `UpperCriticalUser` properties.  However, the value of the `Reading` property is still above at least one `Reading` property of another upper threshold and is not within the normal operating range.
92    #[message(message = "Sensor '%1' reading of %2 (%3) is now below the %4 upper critical threshold but remains outside of normal range.")]
93    #[message(id = "SensorEvent.1.0.0.ReadingBelowUpperCriticalThreshold")]
94    #[message(severity = "crate::models::resource::Health::Warning")]
95    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
96    ReadingBelowUpperCriticalThreshold(
97        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
98        String,
99        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
100        f64,
101        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
102        String,
103        /// This argument shall contain a number that equals the value of the `Reading` property within the `UpperCritical` or `UpperCriticalUser` properties of the `Sensor` resource.
104        f64,
105    ),
106    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource no longer exceeds the value of an internal critical level, but the value still exceeds an internal warning level.  This message shall be used for `Sensor` resources that do not contain readable critical threshold values, such as boolean trip points or similiar hardware mechanisms.  This message shall not be used if the `Reading` property within a corresponding critical threshold is available.
107    #[message(message = "Sensor '%1' reading of %2 (%3) no longer exceeds the critcal level.")]
108    #[message(id = "SensorEvent.1.0.0.ReadingNoLongerCritical")]
109    #[message(severity = "crate::models::resource::Health::Warning")]
110    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
111    ReadingNoLongerCritical(
112        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
113        String,
114        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
115        f64,
116        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
117        String,
118    ),
119    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource is below the value of the `Reading` property within the `LowerCritical` or `LowerCriticalUser` properties.
120    #[message(message = "Sensor '%1' reading of %2 (%3) is below the %4 lower critical threshold.")]
121    #[message(id = "SensorEvent.1.0.0.ReadingBelowLowerCriticalThreshold")]
122    #[message(severity = "crate::models::resource::Health::Critical")]
123    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
124    ReadingBelowLowerCriticalThreshold(
125        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
126        String,
127        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
128        f64,
129        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
130        String,
131        /// This argument shall contain a number that equals the value of the `Reading` property within the `LowerCritical` or `LowerCriticalUser` properties of the `Sensor` resource.
132        f64,
133    ),
134    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource exceeds the value of an internal warning level.  This message shall be used for `Sensor` resources that do not contain readable caution threshold values, such as boolean trip points or similiar hardware mechanisms.  This message shall not be used if the `Reading` property within a corresponding caution threshold is available.
135    #[message(message = "Sensor '%1' reading of %2 (%3) exceeds the warning level.")]
136    #[message(id = "SensorEvent.1.0.0.ReadingWarning")]
137    #[message(severity = "crate::models::resource::Health::Warning")]
138    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
139    ReadingWarning(
140        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
141        String,
142        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
143        f64,
144        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
145        String,
146    ),
147    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource is above the value of the `Reading` property within the `UpperCaution` or `UpperCautionUser` properties.
148    #[message(message = "Sensor '%1' reading of %2 (%3) is above the %4 upper caution threshold.")]
149    #[message(id = "SensorEvent.1.0.0.ReadingAboveUpperCautionThreshold")]
150    #[message(severity = "crate::models::resource::Health::Warning")]
151    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
152    ReadingAboveUpperCautionThreshold(
153        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
154        String,
155        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
156        f64,
157        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
158        String,
159        /// This argument shall contain a number that equals the value of the `Reading` property within the `UpperCaution` or `UpperCautionUser` properties of the `Sensor` resource.
160        f64,
161    ),
162    /// This message shall be used to indicate that the value of the `Reading` in a `Sensor` resource, previously above the threshold, is now below the value of the `Reading` property within the `UpperFatal` property.  However, the value of the `Reading` property is still above at least one `Reading` property of another upper threshold and is not within the normal operating range.
163    #[message(message = "Sensor '%1' reading of %2 (%3) is now below the %4 upper fatal threshold but remains outside of normal range.")]
164    #[message(id = "SensorEvent.1.0.0.ReadingBelowUpperFatalThreshold")]
165    #[message(severity = "crate::models::resource::Health::Critical")]
166    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
167    ReadingBelowUpperFatalThreshold(
168        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
169        String,
170        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
171        f64,
172        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
173        String,
174        /// This argument shall contain a number that equals the value of the `Reading` property within the `UpperFatal` property of the `Sensor` resource.
175        f64,
176    ),
177    /// This message shall be used to indicate that the service is able to communicate with a sensor that had previously failed, or the sensor has been repaired or replaced.
178    #[message(message = "Sensor '%1' has been restored.")]
179    #[message(id = "SensorEvent.1.0.0.SensorRestored")]
180    #[message(severity = "crate::models::resource::Health::OK")]
181    #[message(resolution = "None.")]
182    SensorRestored(
183        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
184        String,
185    ),
186    /// This message shall be used to indicate that the value of the `Reading` property in a `Sensor` resource is above the value of the `Reading` property within the `UpperCritical` or `UpperCriticalUser` properties.
187    #[message(message = "Sensor '%1' reading of %2 (%3) is above the %4 upper critical threshold.")]
188    #[message(id = "SensorEvent.1.0.0.ReadingAboveUpperCriticalThreshold")]
189    #[message(severity = "crate::models::resource::Health::Critical")]
190    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
191    ReadingAboveUpperCriticalThreshold(
192        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
193        String,
194        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
195        f64,
196        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
197        String,
198        /// This argument shall contain a number that equals the value of the `Reading` property within the `UpperCritical` or `UpperCriticalUser` properties of the `Sensor` resource.
199        f64,
200    ),
201    /// This message shall be used to indicate that the service received invalid data while attempting to update the value of the `Reading` property in a `Sensor` resource.
202    #[message(message = "Invalid reading received from sensor '%1'.")]
203    #[message(id = "SensorEvent.1.0.0.InvalidSensorReading")]
204    #[message(severity = "crate::models::resource::Health::Warning")]
205    #[message(resolution = "Check the sensor hardware or connection.")]
206    InvalidSensorReading(
207        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
208        String,
209    ),
210    /// This message shall be used to indicate that the value of the `Reading` in a `Sensor` resource, previously below the threshold, is now above the value of the `Reading` property within the `LowerCritical` or `LowerCriticalUser` properties.  However, the value of the `Reading` property is still below at least one `Reading` property of another lower threshold and is not within the normal operating range.
211    #[message(message = "Sensor '%1' reading of %2 (%3) is now above the %4 lower critical threshold but remains outside of normal range.")]
212    #[message(id = "SensorEvent.1.0.0.ReadingAboveLowerCriticalThreshold")]
213    #[message(severity = "crate::models::resource::Health::Warning")]
214    #[message(resolution = "Check the condition of the resources listed in RelatedItem.")]
215    ReadingAboveLowerCriticalThreshold(
216        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
217        String,
218        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
219        f64,
220        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
221        String,
222        /// This argument shall contain a number that equals the value of the `Reading` property within the `LowerCritical` or `LowerCriticalUser` properties of the `Sensor` resource.
223        f64,
224    ),
225    /// This message shall be used to indicate that the value of the `Reading` property within a `Sensor` resource has returned to its normal operating range.
226    #[message(message = "Sensor '%1' reading of %2 (%3) is within normal operating range.")]
227    #[message(id = "SensorEvent.1.0.0.SensorReadingNormalRange")]
228    #[message(severity = "crate::models::resource::Health::OK")]
229    #[message(resolution = "None.")]
230    SensorReadingNormalRange(
231        /// This argument shall contain a string that identifies or describes the `Sensor` resource.
232        String,
233        /// This argument shall contain a number that equals the value of the `Reading` property of the `Sensor` resource.
234        f64,
235        /// This argument shall contain a string that equals the value of the `ReadingUnits` property of the `Sensor` resource.  Unitless readings should use `count`.
236        String,
237    ),
238}