redfish_codegen/models/job/v1_2_1/
job.rs

1// Generated by redfish-codegen. Do not modify.
2
3use crate::models;
4
5/// The Job schema contains information about a job that a Redfish job service schedules or executes.  Clients create jobs to describe a series of operations that occur at periodic intervals.
6#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
7#[derive(derivative::Derivative)]
8#[derivative(Default)]
9pub struct Job {
10    #[serde(rename = "@odata.context")]
11    #[serde(skip_deserializing)]
12    #[serde(default, skip_serializing_if = "Option::is_none")]
13    pub odata_context: Option<models::odata_v4::Context>,
14    #[serde(rename = "@odata.etag")]
15    #[serde(skip_deserializing)]
16    #[serde(default, skip_serializing_if = "Option::is_none")]
17    pub odata_etag: Option<models::odata_v4::Etag>,
18    #[serde(rename = "@odata.id")]
19    #[serde(skip_deserializing)]
20    pub odata_id: models::odata_v4::Id,
21    #[serde(rename = "@odata.type")]
22    #[serde(skip_deserializing)]
23    #[derivative(Default(value = "models::odata_v4::Type(\"#Job.v1_2_1.Job\".to_string())"))]
24    pub odata_type: models::odata_v4::Type,
25    #[serde(rename = "Actions")]
26    #[serde(default, skip_serializing_if = "Option::is_none")]
27    pub actions: Option<models::job::v1_2_1::Actions>,
28    /// The person or program that created this job entry.
29    #[serde(rename = "CreatedBy")]
30    #[serde(default, skip_serializing_if = "Option::is_none")]
31    pub created_by: Option<String>,
32    #[serde(rename = "Description")]
33    #[serde(default, skip_serializing_if = "Option::is_none")]
34    pub description: Option<models::resource::Description>,
35    /// The date and time when the job was completed.
36    #[serde(rename = "EndTime")]
37    #[serde(default, skip_serializing_if = "Option::is_none")]
38    pub end_time: Option<String>,
39    /// The estimated total time required to complete the job.
40    #[serde(rename = "EstimatedDuration")]
41    #[serde(default, skip_serializing_if = "Option::is_none")]
42    pub estimated_duration: Option<String>,
43    /// An indication of whether the contents of the payload should be hidden from view after the job has been created.  If `true`, responses do not return the payload.  If `false`, responses return the payload.  If this property is not present when the job is created, the default is `false`.
44    #[serde(rename = "HidePayload")]
45    #[serde(default, skip_serializing_if = "Option::is_none")]
46    pub hide_payload: Option<bool>,
47    #[serde(rename = "Id")]
48    #[serde(skip_deserializing)]
49    pub id: models::resource::Id,
50    #[serde(rename = "JobState")]
51    #[serde(default, skip_serializing_if = "Option::is_none")]
52    pub job_state: Option<models::job::v1_2_1::JobState>,
53    #[serde(rename = "JobStatus")]
54    #[serde(default, skip_serializing_if = "Option::is_none")]
55    pub job_status: Option<models::resource::Health>,
56    #[serde(rename = "Links")]
57    #[serde(default, skip_serializing_if = "Option::is_none")]
58    pub links: Option<models::job::v1_2_1::Links>,
59    /// The maximum amount of time the job is allowed to execute.
60    #[serde(rename = "MaxExecutionTime")]
61    #[serde(default, skip_serializing_if = "Option::is_none")]
62    pub max_execution_time: Option<String>,
63    /// An array of messages associated with the job.
64    #[serde(rename = "Messages")]
65    #[serde(default, skip_serializing_if = "Option::is_none")]
66    pub messages: Option<Vec<models::message::Message>>,
67    #[serde(rename = "Name")]
68    #[serde(skip_deserializing)]
69    pub name: models::resource::Name,
70    #[serde(rename = "Oem")]
71    #[serde(default, skip_serializing_if = "Option::is_none")]
72    pub oem: Option<models::resource::Oem>,
73    #[serde(rename = "Payload")]
74    #[serde(default, skip_serializing_if = "Option::is_none")]
75    pub payload: Option<models::job::v1_2_1::Payload>,
76    /// The completion percentage of this job.
77    #[serde(rename = "PercentComplete")]
78    #[serde(default, skip_serializing_if = "Option::is_none")]
79    pub percent_complete: Option<i64>,
80    #[serde(rename = "Schedule")]
81    #[serde(default, skip_serializing_if = "Option::is_none")]
82    pub schedule: Option<models::schedule::Schedule>,
83    /// The date and time when the job was started or is scheduled to start.
84    #[serde(rename = "StartTime")]
85    #[serde(default, skip_serializing_if = "Option::is_none")]
86    pub start_time: Option<String>,
87    /// The serialized execution order of the job steps.
88    #[serde(rename = "StepOrder")]
89    #[serde(default, skip_serializing_if = "Option::is_none")]
90    pub step_order: Option<Vec<String>>,
91    #[serde(rename = "Steps")]
92    #[serde(default, skip_serializing_if = "Option::is_none")]
93    pub steps: Option<models::odata_v4::IdRef>,
94}
95
96impl crate::Metadata<'static> for Job {
97    const JSON_SCHEMA: &'static str = "Job.v1_2_1.json";
98}