redfish-codegen 0.3.1

An unopinionated translation of the Redfish specification into Rust.
Documentation
// Generated by redfish-codegen. Do not modify.

use redfish_macros::IntoRedfishMessage;

/// This registry defines the messages for job related events.
#[derive(Clone, Debug, IntoRedfishMessage)]
#[message(crate::models::message::v1_1_2::Message)]
pub enum JobEvent {
    /// This message shall be used to indicate that a job has been removed.
    #[message(message = "The job with Id '%1' has been removed.")]
    #[message(id = "JobEvent.1.0.0.JobRemoved")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "None.")]
    JobRemoved(
        /// This argument shall contain the value of the `Id` property of the job resource that has been removed.
        String,
    ),
    /// This message shall be used to indicate that a job has been susepended and the `JobState` property transitioned to `Suspended`, `Interrupted`, or `UserIntervention`.
    #[message(message = "The job with Id '%1' has been susepended.")]
    #[message(id = "JobEvent.1.0.0.JobSuspended")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "None.")]
    JobSuspended(
        /// This argument shall contain the value of the `Id` property of the job resource that has been susepended.
        String,
    ),
    /// This message shall be used to indicate that a job has resumed and the `JobState` property transitioned to `Running` from `Suspended`, `Interrupted`, or `UserIntervention`.
    #[message(message = "The job with Id '%1' has resumed.")]
    #[message(id = "JobEvent.1.0.0.JobResumed")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "None.")]
    JobResumed(
        /// This argument shall contain the value of the `Id` property of the job resource that has resumed.
        String,
    ),
    /// This message shall be used to indicate that a job has completed and the `JobState` property transitioned to `Exception`.
    #[message(message = "The job with Id '%1' has completed with warnings or errors.")]
    #[message(id = "JobEvent.1.0.0.JobCompletedException")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "None.")]
    JobCompletedException(
        /// This argument shall contain the value of the `Id` property of the job resource that has completed with warnings or errors.
        String,
    ),
    /// This message shall be used to indicate that a job has changed progress.
    #[message(message = "The job with Id '%1' has changed to progress %2 percent complete.")]
    #[message(id = "JobEvent.1.0.0.JobProgressChanged")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "None.")]
    JobProgressChanged(
        /// This argument shall contain the value of the `Id` property of the job resource that has changed progress.
        String,
        /// This argument shall contain the percent completion of the job that has changed progress and shall be a value from 0 to 100.
        f64,
    ),
    /// This message shall be used to indicate that a job has started as the `JobState` property transitions to `Starting` or `Running`.
    #[message(message = "The job with Id '%1' has started.")]
    #[message(id = "JobEvent.1.0.0.JobStarted")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "None.")]
    JobStarted(
        /// This argument shall contain the value of the `Id` property of the job resource that has started.
        String,
    ),
    /// This message shall be used to indicate that a job has completed and the `JobState` property transitioned to `Completed`.
    #[message(message = "The job with Id '%1' has completed.")]
    #[message(id = "JobEvent.1.0.0.JobCompletedOK")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "None.")]
    JobCompletedOK(
        /// This argument shall contain the value of the `Id` property of the job resource that has completed.
        String,
    ),
    /// This message shall be used to indicate that a job has been cancelled and the `JobState` property transitioned to `Cancelled`.
    #[message(message = "The job with Id '%1' has been cancelled.")]
    #[message(id = "JobEvent.1.0.0.JobCancelled")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "None.")]
    JobCancelled(
        /// This argument shall contain the value of the `Id` property of the job resource that has been cancelled.
        String,
    ),
}