k8s_openapi/v1_32/api/apps/v1/
stateful_set.rs

1// Generated from definition io.k8s.api.apps.v1.StatefulSet
2
3/// StatefulSet represents a set of pods with consistent identities. Identities are defined as:
4///   - Network: A single stable DNS and hostname.
5///   - Storage: As many VolumeClaims as requested.
6///
7/// The StatefulSet guarantees that a given network identity will always map to the same storage identity.
8#[derive(Clone, Debug, Default, PartialEq)]
9pub struct StatefulSet {
10    /// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
11    pub metadata: crate::apimachinery::pkg::apis::meta::v1::ObjectMeta,
12
13    /// Spec defines the desired identities of pods in this set.
14    pub spec: Option<crate::api::apps::v1::StatefulSetSpec>,
15
16    /// Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
17    pub status: Option<crate::api::apps::v1::StatefulSetStatus>,
18}
19
20impl crate::Resource for StatefulSet {
21    const API_VERSION: &'static str = "apps/v1";
22    const GROUP: &'static str = "apps";
23    const KIND: &'static str = "StatefulSet";
24    const VERSION: &'static str = "v1";
25    const URL_PATH_SEGMENT: &'static str = "statefulsets";
26    type Scope = crate::NamespaceResourceScope;
27}
28
29impl crate::ListableResource for StatefulSet {
30    const LIST_KIND: &'static str = "StatefulSetList";
31}
32
33impl crate::Metadata for StatefulSet {
34    type Ty = crate::apimachinery::pkg::apis::meta::v1::ObjectMeta;
35
36    fn metadata(&self) -> &<Self as crate::Metadata>::Ty {
37        &self.metadata
38    }
39
40    fn metadata_mut(&mut self) -> &mut<Self as crate::Metadata>::Ty {
41        &mut self.metadata
42    }
43}
44
45impl crate::DeepMerge for StatefulSet {
46    fn merge_from(&mut self, other: Self) {
47        crate::DeepMerge::merge_from(&mut self.metadata, other.metadata);
48        crate::DeepMerge::merge_from(&mut self.spec, other.spec);
49        crate::DeepMerge::merge_from(&mut self.status, other.status);
50    }
51}
52
53impl<'de> crate::serde::Deserialize<'de> for StatefulSet {
54    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
55        #[allow(non_camel_case_types)]
56        enum Field {
57            Key_api_version,
58            Key_kind,
59            Key_metadata,
60            Key_spec,
61            Key_status,
62            Other,
63        }
64
65        impl<'de> crate::serde::Deserialize<'de> for Field {
66            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
67                struct Visitor;
68
69                impl crate::serde::de::Visitor<'_> for Visitor {
70                    type Value = Field;
71
72                    fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
73                        f.write_str("field identifier")
74                    }
75
76                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
77                        Ok(match v {
78                            "apiVersion" => Field::Key_api_version,
79                            "kind" => Field::Key_kind,
80                            "metadata" => Field::Key_metadata,
81                            "spec" => Field::Key_spec,
82                            "status" => Field::Key_status,
83                            _ => Field::Other,
84                        })
85                    }
86                }
87
88                deserializer.deserialize_identifier(Visitor)
89            }
90        }
91
92        struct Visitor;
93
94        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
95            type Value = StatefulSet;
96
97            fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
98                f.write_str(<Self::Value as crate::Resource>::KIND)
99            }
100
101            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
102                let mut value_metadata: Option<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta> = None;
103                let mut value_spec: Option<crate::api::apps::v1::StatefulSetSpec> = None;
104                let mut value_status: Option<crate::api::apps::v1::StatefulSetStatus> = None;
105
106                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
107                    match key {
108                        Field::Key_api_version => {
109                            let value_api_version: String = crate::serde::de::MapAccess::next_value(&mut map)?;
110                            if value_api_version != <Self::Value as crate::Resource>::API_VERSION {
111                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_api_version), &<Self::Value as crate::Resource>::API_VERSION));
112                            }
113                        },
114                        Field::Key_kind => {
115                            let value_kind: String = crate::serde::de::MapAccess::next_value(&mut map)?;
116                            if value_kind != <Self::Value as crate::Resource>::KIND {
117                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_kind), &<Self::Value as crate::Resource>::KIND));
118                            }
119                        },
120                        Field::Key_metadata => value_metadata = crate::serde::de::MapAccess::next_value(&mut map)?,
121                        Field::Key_spec => value_spec = crate::serde::de::MapAccess::next_value(&mut map)?,
122                        Field::Key_status => value_status = crate::serde::de::MapAccess::next_value(&mut map)?,
123                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
124                    }
125                }
126
127                Ok(StatefulSet {
128                    metadata: value_metadata.unwrap_or_default(),
129                    spec: value_spec,
130                    status: value_status,
131                })
132            }
133        }
134
135        deserializer.deserialize_struct(
136            <Self as crate::Resource>::KIND,
137            &[
138                "apiVersion",
139                "kind",
140                "metadata",
141                "spec",
142                "status",
143            ],
144            Visitor,
145        )
146    }
147}
148
149impl crate::serde::Serialize for StatefulSet {
150    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
151        let mut state = serializer.serialize_struct(
152            <Self as crate::Resource>::KIND,
153            3 +
154            self.spec.as_ref().map_or(0, |_| 1) +
155            self.status.as_ref().map_or(0, |_| 1),
156        )?;
157        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "apiVersion", <Self as crate::Resource>::API_VERSION)?;
158        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "kind", <Self as crate::Resource>::KIND)?;
159        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "metadata", &self.metadata)?;
160        if let Some(value) = &self.spec {
161            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "spec", value)?;
162        }
163        if let Some(value) = &self.status {
164            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "status", value)?;
165        }
166        crate::serde::ser::SerializeStruct::end(state)
167    }
168}
169
170#[cfg(feature = "schemars")]
171impl crate::schemars::JsonSchema for StatefulSet {
172    fn schema_name() -> String {
173        "io.k8s.api.apps.v1.StatefulSet".to_owned()
174    }
175
176    fn json_schema(__gen: &mut crate::schemars::gen::SchemaGenerator) -> crate::schemars::schema::Schema {
177        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
178            metadata: Some(Box::new(crate::schemars::schema::Metadata {
179                description: Some("StatefulSet represents a set of pods with consistent identities. Identities are defined as:\n  - Network: A single stable DNS and hostname.\n  - Storage: As many VolumeClaims as requested.\n\nThe StatefulSet guarantees that a given network identity will always map to the same storage identity.".to_owned()),
180                ..Default::default()
181            })),
182            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::Object))),
183            object: Some(Box::new(crate::schemars::schema::ObjectValidation {
184                properties: [
185                    (
186                        "apiVersion".to_owned(),
187                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
188                            metadata: Some(Box::new(crate::schemars::schema::Metadata {
189                                description: Some("APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources".to_owned()),
190                                ..Default::default()
191                            })),
192                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::String))),
193                            ..Default::default()
194                        }),
195                    ),
196                    (
197                        "kind".to_owned(),
198                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
199                            metadata: Some(Box::new(crate::schemars::schema::Metadata {
200                                description: Some("Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds".to_owned()),
201                                ..Default::default()
202                            })),
203                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::String))),
204                            ..Default::default()
205                        }),
206                    ),
207                    (
208                        "metadata".to_owned(),
209                        {
210                            let mut schema_obj = __gen.subschema_for::<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta>().into_object();
211                            schema_obj.metadata = Some(Box::new(crate::schemars::schema::Metadata {
212                                description: Some("Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata".to_owned()),
213                                ..Default::default()
214                            }));
215                            crate::schemars::schema::Schema::Object(schema_obj)
216                        },
217                    ),
218                    (
219                        "spec".to_owned(),
220                        {
221                            let mut schema_obj = __gen.subschema_for::<crate::api::apps::v1::StatefulSetSpec>().into_object();
222                            schema_obj.metadata = Some(Box::new(crate::schemars::schema::Metadata {
223                                description: Some("Spec defines the desired identities of pods in this set.".to_owned()),
224                                ..Default::default()
225                            }));
226                            crate::schemars::schema::Schema::Object(schema_obj)
227                        },
228                    ),
229                    (
230                        "status".to_owned(),
231                        {
232                            let mut schema_obj = __gen.subschema_for::<crate::api::apps::v1::StatefulSetStatus>().into_object();
233                            schema_obj.metadata = Some(Box::new(crate::schemars::schema::Metadata {
234                                description: Some("Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.".to_owned()),
235                                ..Default::default()
236                            }));
237                            crate::schemars::schema::Schema::Object(schema_obj)
238                        },
239                    ),
240                ].into(),
241                required: [
242                    "metadata".to_owned(),
243                ].into(),
244                ..Default::default()
245            })),
246            ..Default::default()
247        })
248    }
249}