openshift_openapi/v4_5/api/template/v1/
parameter.rs

1// Generated from definition com.github.openshift.api.template.v1.Parameter
2
3/// Parameter defines a name/value variable that is to be processed during the Template to Config transformation.
4#[derive(Clone, Debug, Default, PartialEq)]
5pub struct Parameter {
6    /// Description of a parameter. Optional.
7    pub description: Option<String>,
8
9    /// Optional: The name that will show in UI instead of parameter 'Name'
10    pub display_name: Option<String>,
11
12    /// From is an input value for the generator. Optional.
13    pub from: Option<String>,
14
15    /// generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.
16    ///
17    /// The only supported generator is "expression", which accepts a "from" value in the form of a simple regular expression containing the range expression "\[a-zA-Z0-9\]", and the length expression "a{length}".
18    ///
19    /// Examples:
20    ///
21    /// from             | value ----------------------------- "test\[0-9\]{1}x"  | "test7x" "\[0-1\]{8}"       | "01001100" "0x\[A-F0-9\]{4}"  | "0xB3AF" "\[a-zA-Z0-9\]{8}" | "hW4yQU5i"
22    pub generate: Option<String>,
23
24    /// Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.
25    pub name: String,
26
27    /// Optional: Indicates the parameter must have a value.  Defaults to false.
28    pub required: Option<bool>,
29
30    /// Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.
31    pub value: Option<String>,
32}
33
34impl<'de> serde::Deserialize<'de> for Parameter {
35    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: serde::Deserializer<'de> {
36        #[allow(non_camel_case_types)]
37        enum Field {
38            Key_description,
39            Key_display_name,
40            Key_from,
41            Key_generate,
42            Key_name,
43            Key_required,
44            Key_value,
45            Other,
46        }
47
48        impl<'de> serde::Deserialize<'de> for Field {
49            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: serde::Deserializer<'de> {
50                struct Visitor;
51
52                impl<'de> serde::de::Visitor<'de> for Visitor {
53                    type Value = Field;
54
55                    fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
56                        f.write_str("field identifier")
57                    }
58
59                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: serde::de::Error {
60                        Ok(match v {
61                            "description" => Field::Key_description,
62                            "displayName" => Field::Key_display_name,
63                            "from" => Field::Key_from,
64                            "generate" => Field::Key_generate,
65                            "name" => Field::Key_name,
66                            "required" => Field::Key_required,
67                            "value" => Field::Key_value,
68                            _ => Field::Other,
69                        })
70                    }
71                }
72
73                deserializer.deserialize_identifier(Visitor)
74            }
75        }
76
77        struct Visitor;
78
79        impl<'de> serde::de::Visitor<'de> for Visitor {
80            type Value = Parameter;
81
82            fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
83                f.write_str("Parameter")
84            }
85
86            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: serde::de::MapAccess<'de> {
87                let mut value_description: Option<String> = None;
88                let mut value_display_name: Option<String> = None;
89                let mut value_from: Option<String> = None;
90                let mut value_generate: Option<String> = None;
91                let mut value_name: Option<String> = None;
92                let mut value_required: Option<bool> = None;
93                let mut value_value: Option<String> = None;
94
95                while let Some(key) = serde::de::MapAccess::next_key::<Field>(&mut map)? {
96                    match key {
97                        Field::Key_description => value_description = serde::de::MapAccess::next_value(&mut map)?,
98                        Field::Key_display_name => value_display_name = serde::de::MapAccess::next_value(&mut map)?,
99                        Field::Key_from => value_from = serde::de::MapAccess::next_value(&mut map)?,
100                        Field::Key_generate => value_generate = serde::de::MapAccess::next_value(&mut map)?,
101                        Field::Key_name => value_name = Some(serde::de::MapAccess::next_value(&mut map)?),
102                        Field::Key_required => value_required = serde::de::MapAccess::next_value(&mut map)?,
103                        Field::Key_value => value_value = serde::de::MapAccess::next_value(&mut map)?,
104                        Field::Other => { let _: serde::de::IgnoredAny = serde::de::MapAccess::next_value(&mut map)?; },
105                    }
106                }
107
108                Ok(Parameter {
109                    description: value_description,
110                    display_name: value_display_name,
111                    from: value_from,
112                    generate: value_generate,
113                    name: value_name.ok_or_else(|| serde::de::Error::missing_field("name"))?,
114                    required: value_required,
115                    value: value_value,
116                })
117            }
118        }
119
120        deserializer.deserialize_struct(
121            "Parameter",
122            &[
123                "description",
124                "displayName",
125                "from",
126                "generate",
127                "name",
128                "required",
129                "value",
130            ],
131            Visitor,
132        )
133    }
134}
135
136impl serde::Serialize for Parameter {
137    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: serde::Serializer {
138        let mut state = serializer.serialize_struct(
139            "Parameter",
140            1 +
141            self.description.as_ref().map_or(0, |_| 1) +
142            self.display_name.as_ref().map_or(0, |_| 1) +
143            self.from.as_ref().map_or(0, |_| 1) +
144            self.generate.as_ref().map_or(0, |_| 1) +
145            self.required.as_ref().map_or(0, |_| 1) +
146            self.value.as_ref().map_or(0, |_| 1),
147        )?;
148        if let Some(value) = &self.description {
149            serde::ser::SerializeStruct::serialize_field(&mut state, "description", value)?;
150        }
151        if let Some(value) = &self.display_name {
152            serde::ser::SerializeStruct::serialize_field(&mut state, "displayName", value)?;
153        }
154        if let Some(value) = &self.from {
155            serde::ser::SerializeStruct::serialize_field(&mut state, "from", value)?;
156        }
157        if let Some(value) = &self.generate {
158            serde::ser::SerializeStruct::serialize_field(&mut state, "generate", value)?;
159        }
160        serde::ser::SerializeStruct::serialize_field(&mut state, "name", &self.name)?;
161        if let Some(value) = &self.required {
162            serde::ser::SerializeStruct::serialize_field(&mut state, "required", value)?;
163        }
164        if let Some(value) = &self.value {
165            serde::ser::SerializeStruct::serialize_field(&mut state, "value", value)?;
166        }
167        serde::ser::SerializeStruct::end(state)
168    }
169}