k8s_openapi/v1_30/api/resource/v1alpha2/
resource_claim_parameters.rs

1// Generated from definition io.k8s.api.resource.v1alpha2.ResourceClaimParameters
2
3/// ResourceClaimParameters defines resource requests for a ResourceClaim in an in-tree format understood by Kubernetes.
4#[derive(Clone, Debug, Default, PartialEq)]
5pub struct ResourceClaimParameters {
6    /// DriverRequests describes all resources that are needed for the allocated claim. A single claim may use resources coming from different drivers. For each driver, this array has at most one entry which then may have one or more per-driver requests.
7    ///
8    /// May be empty, in which case the claim can always be allocated.
9    pub driver_requests: Option<Vec<crate::api::resource::v1alpha2::DriverRequests>>,
10
11    /// If this object was created from some other resource, then this links back to that resource. This field is used to find the in-tree representation of the claim parameters when the parameter reference of the claim refers to some unknown type.
12    pub generated_from: Option<crate::api::resource::v1alpha2::ResourceClaimParametersReference>,
13
14    /// Standard object metadata
15    pub metadata: crate::apimachinery::pkg::apis::meta::v1::ObjectMeta,
16
17    /// Shareable indicates whether the allocated claim is meant to be shareable by multiple consumers at the same time.
18    pub shareable: Option<bool>,
19}
20
21impl crate::Resource for ResourceClaimParameters {
22    const API_VERSION: &'static str = "resource.k8s.io/v1alpha2";
23    const GROUP: &'static str = "resource.k8s.io";
24    const KIND: &'static str = "ResourceClaimParameters";
25    const VERSION: &'static str = "v1alpha2";
26    const URL_PATH_SEGMENT: &'static str = "resourceclaimparameters";
27    type Scope = crate::NamespaceResourceScope;
28}
29
30impl crate::ListableResource for ResourceClaimParameters {
31    const LIST_KIND: &'static str = "ResourceClaimParametersList";
32}
33
34impl crate::Metadata for ResourceClaimParameters {
35    type Ty = crate::apimachinery::pkg::apis::meta::v1::ObjectMeta;
36
37    fn metadata(&self) -> &<Self as crate::Metadata>::Ty {
38        &self.metadata
39    }
40
41    fn metadata_mut(&mut self) -> &mut<Self as crate::Metadata>::Ty {
42        &mut self.metadata
43    }
44}
45
46impl crate::DeepMerge for ResourceClaimParameters {
47    fn merge_from(&mut self, other: Self) {
48        crate::merge_strategies::list::atomic(&mut self.driver_requests, other.driver_requests);
49        crate::DeepMerge::merge_from(&mut self.generated_from, other.generated_from);
50        crate::DeepMerge::merge_from(&mut self.metadata, other.metadata);
51        crate::DeepMerge::merge_from(&mut self.shareable, other.shareable);
52    }
53}
54
55impl<'de> crate::serde::Deserialize<'de> for ResourceClaimParameters {
56    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
57        #[allow(non_camel_case_types)]
58        enum Field {
59            Key_api_version,
60            Key_kind,
61            Key_driver_requests,
62            Key_generated_from,
63            Key_metadata,
64            Key_shareable,
65            Other,
66        }
67
68        impl<'de> crate::serde::Deserialize<'de> for Field {
69            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
70                struct Visitor;
71
72                impl crate::serde::de::Visitor<'_> for Visitor {
73                    type Value = Field;
74
75                    fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
76                        f.write_str("field identifier")
77                    }
78
79                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
80                        Ok(match v {
81                            "apiVersion" => Field::Key_api_version,
82                            "kind" => Field::Key_kind,
83                            "driverRequests" => Field::Key_driver_requests,
84                            "generatedFrom" => Field::Key_generated_from,
85                            "metadata" => Field::Key_metadata,
86                            "shareable" => Field::Key_shareable,
87                            _ => Field::Other,
88                        })
89                    }
90                }
91
92                deserializer.deserialize_identifier(Visitor)
93            }
94        }
95
96        struct Visitor;
97
98        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
99            type Value = ResourceClaimParameters;
100
101            fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
102                f.write_str(<Self::Value as crate::Resource>::KIND)
103            }
104
105            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
106                let mut value_driver_requests: Option<Vec<crate::api::resource::v1alpha2::DriverRequests>> = None;
107                let mut value_generated_from: Option<crate::api::resource::v1alpha2::ResourceClaimParametersReference> = None;
108                let mut value_metadata: Option<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta> = None;
109                let mut value_shareable: Option<bool> = None;
110
111                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
112                    match key {
113                        Field::Key_api_version => {
114                            let value_api_version: String = crate::serde::de::MapAccess::next_value(&mut map)?;
115                            if value_api_version != <Self::Value as crate::Resource>::API_VERSION {
116                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_api_version), &<Self::Value as crate::Resource>::API_VERSION));
117                            }
118                        },
119                        Field::Key_kind => {
120                            let value_kind: String = crate::serde::de::MapAccess::next_value(&mut map)?;
121                            if value_kind != <Self::Value as crate::Resource>::KIND {
122                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_kind), &<Self::Value as crate::Resource>::KIND));
123                            }
124                        },
125                        Field::Key_driver_requests => value_driver_requests = crate::serde::de::MapAccess::next_value(&mut map)?,
126                        Field::Key_generated_from => value_generated_from = crate::serde::de::MapAccess::next_value(&mut map)?,
127                        Field::Key_metadata => value_metadata = crate::serde::de::MapAccess::next_value(&mut map)?,
128                        Field::Key_shareable => value_shareable = crate::serde::de::MapAccess::next_value(&mut map)?,
129                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
130                    }
131                }
132
133                Ok(ResourceClaimParameters {
134                    driver_requests: value_driver_requests,
135                    generated_from: value_generated_from,
136                    metadata: value_metadata.unwrap_or_default(),
137                    shareable: value_shareable,
138                })
139            }
140        }
141
142        deserializer.deserialize_struct(
143            <Self as crate::Resource>::KIND,
144            &[
145                "apiVersion",
146                "kind",
147                "driverRequests",
148                "generatedFrom",
149                "metadata",
150                "shareable",
151            ],
152            Visitor,
153        )
154    }
155}
156
157impl crate::serde::Serialize for ResourceClaimParameters {
158    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
159        let mut state = serializer.serialize_struct(
160            <Self as crate::Resource>::KIND,
161            3 +
162            self.driver_requests.as_ref().map_or(0, |_| 1) +
163            self.generated_from.as_ref().map_or(0, |_| 1) +
164            self.shareable.as_ref().map_or(0, |_| 1),
165        )?;
166        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "apiVersion", <Self as crate::Resource>::API_VERSION)?;
167        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "kind", <Self as crate::Resource>::KIND)?;
168        if let Some(value) = &self.driver_requests {
169            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "driverRequests", value)?;
170        }
171        if let Some(value) = &self.generated_from {
172            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "generatedFrom", value)?;
173        }
174        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "metadata", &self.metadata)?;
175        if let Some(value) = &self.shareable {
176            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "shareable", value)?;
177        }
178        crate::serde::ser::SerializeStruct::end(state)
179    }
180}
181
182#[cfg(feature = "schemars")]
183impl crate::schemars::JsonSchema for ResourceClaimParameters {
184    fn schema_name() -> String {
185        "io.k8s.api.resource.v1alpha2.ResourceClaimParameters".to_owned()
186    }
187
188    fn json_schema(__gen: &mut crate::schemars::gen::SchemaGenerator) -> crate::schemars::schema::Schema {
189        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
190            metadata: Some(Box::new(crate::schemars::schema::Metadata {
191                description: Some("ResourceClaimParameters defines resource requests for a ResourceClaim in an in-tree format understood by Kubernetes.".to_owned()),
192                ..Default::default()
193            })),
194            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::Object))),
195            object: Some(Box::new(crate::schemars::schema::ObjectValidation {
196                properties: [
197                    (
198                        "apiVersion".to_owned(),
199                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
200                            metadata: Some(Box::new(crate::schemars::schema::Metadata {
201                                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()),
202                                ..Default::default()
203                            })),
204                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::String))),
205                            ..Default::default()
206                        }),
207                    ),
208                    (
209                        "driverRequests".to_owned(),
210                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
211                            metadata: Some(Box::new(crate::schemars::schema::Metadata {
212                                description: Some("DriverRequests describes all resources that are needed for the allocated claim. A single claim may use resources coming from different drivers. For each driver, this array has at most one entry which then may have one or more per-driver requests.\n\nMay be empty, in which case the claim can always be allocated.".to_owned()),
213                                ..Default::default()
214                            })),
215                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::Array))),
216                            array: Some(Box::new(crate::schemars::schema::ArrayValidation {
217                                items: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(__gen.subschema_for::<crate::api::resource::v1alpha2::DriverRequests>()))),
218                                ..Default::default()
219                            })),
220                            ..Default::default()
221                        }),
222                    ),
223                    (
224                        "generatedFrom".to_owned(),
225                        {
226                            let mut schema_obj = __gen.subschema_for::<crate::api::resource::v1alpha2::ResourceClaimParametersReference>().into_object();
227                            schema_obj.metadata = Some(Box::new(crate::schemars::schema::Metadata {
228                                description: Some("If this object was created from some other resource, then this links back to that resource. This field is used to find the in-tree representation of the claim parameters when the parameter reference of the claim refers to some unknown type.".to_owned()),
229                                ..Default::default()
230                            }));
231                            crate::schemars::schema::Schema::Object(schema_obj)
232                        },
233                    ),
234                    (
235                        "kind".to_owned(),
236                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
237                            metadata: Some(Box::new(crate::schemars::schema::Metadata {
238                                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()),
239                                ..Default::default()
240                            })),
241                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::String))),
242                            ..Default::default()
243                        }),
244                    ),
245                    (
246                        "metadata".to_owned(),
247                        {
248                            let mut schema_obj = __gen.subschema_for::<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta>().into_object();
249                            schema_obj.metadata = Some(Box::new(crate::schemars::schema::Metadata {
250                                description: Some("Standard object metadata".to_owned()),
251                                ..Default::default()
252                            }));
253                            crate::schemars::schema::Schema::Object(schema_obj)
254                        },
255                    ),
256                    (
257                        "shareable".to_owned(),
258                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
259                            metadata: Some(Box::new(crate::schemars::schema::Metadata {
260                                description: Some("Shareable indicates whether the allocated claim is meant to be shareable by multiple consumers at the same time.".to_owned()),
261                                ..Default::default()
262                            })),
263                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(Box::new(crate::schemars::schema::InstanceType::Boolean))),
264                            ..Default::default()
265                        }),
266                    ),
267                ].into(),
268                required: [
269                    "metadata".to_owned(),
270                ].into(),
271                ..Default::default()
272            })),
273            ..Default::default()
274        })
275    }
276}
k8s_openapi/v1_30/api/resource/v1alpha2/resource_claim_parameters.rs

k8s_openapi/v1_30/api/resource/v1alpha2/
resource_claim_parameters.rs
