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

1// Generated from definition io.k8s.api.resource.v1alpha2.ResourceClass
2
3/// ResourceClass is used by administrators to influence how resources are allocated.
4///
5/// This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
6#[derive(Clone, Debug, Default, PartialEq)]
7pub struct ResourceClass {
8    /// DriverName defines the name of the dynamic resource driver that is used for allocation of a ResourceClaim that uses this class.
9    ///
10    /// Resource drivers have a unique name in forward domain order (acme.example.com).
11    pub driver_name: std::string::String,
12
13    /// Standard object metadata
14    pub metadata: crate::apimachinery::pkg::apis::meta::v1::ObjectMeta,
15
16    /// ParametersRef references an arbitrary separate object that may hold parameters that will be used by the driver when allocating a resource that uses this class. A dynamic resource driver can distinguish between parameters stored here and and those stored in ResourceClaimSpec.
17    pub parameters_ref: Option<crate::api::resource::v1alpha2::ResourceClassParametersReference>,
18
19    /// If and only if allocation of claims using this class is handled via structured parameters, then StructuredParameters must be set to true.
20    pub structured_parameters: Option<bool>,
21
22    /// Only nodes matching the selector will be considered by the scheduler when trying to find a Node that fits a Pod when that Pod uses a ResourceClaim that has not been allocated yet.
23    ///
24    /// Setting this field is optional. If null, all nodes are candidates.
25    pub suitable_nodes: Option<crate::api::core::v1::NodeSelector>,
26}
27
28impl crate::Resource for ResourceClass {
29    const API_VERSION: &'static str = "resource.k8s.io/v1alpha2";
30    const GROUP: &'static str = "resource.k8s.io";
31    const KIND: &'static str = "ResourceClass";
32    const VERSION: &'static str = "v1alpha2";
33    const URL_PATH_SEGMENT: &'static str = "resourceclasses";
34    type Scope = crate::ClusterResourceScope;
35}
36
37impl crate::ListableResource for ResourceClass {
38    const LIST_KIND: &'static str = "ResourceClassList";
39}
40
41impl crate::Metadata for ResourceClass {
42    type Ty = crate::apimachinery::pkg::apis::meta::v1::ObjectMeta;
43
44    fn metadata(&self) -> &<Self as crate::Metadata>::Ty {
45        &self.metadata
46    }
47
48    fn metadata_mut(&mut self) -> &mut<Self as crate::Metadata>::Ty {
49        &mut self.metadata
50    }
51}
52
53impl crate::DeepMerge for ResourceClass {
54    fn merge_from(&mut self, other: Self) {
55        crate::DeepMerge::merge_from(&mut self.driver_name, other.driver_name);
56        crate::DeepMerge::merge_from(&mut self.metadata, other.metadata);
57        crate::DeepMerge::merge_from(&mut self.parameters_ref, other.parameters_ref);
58        crate::DeepMerge::merge_from(&mut self.structured_parameters, other.structured_parameters);
59        crate::DeepMerge::merge_from(&mut self.suitable_nodes, other.suitable_nodes);
60    }
61}
62
63impl<'de> crate::serde::Deserialize<'de> for ResourceClass {
64    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
65        #[allow(non_camel_case_types)]
66        enum Field {
67            Key_api_version,
68            Key_kind,
69            Key_driver_name,
70            Key_metadata,
71            Key_parameters_ref,
72            Key_structured_parameters,
73            Key_suitable_nodes,
74            Other,
75        }
76
77        impl<'de> crate::serde::Deserialize<'de> for Field {
78            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
79                struct Visitor;
80
81                impl crate::serde::de::Visitor<'_> for Visitor {
82                    type Value = Field;
83
84                    fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
85                        f.write_str("field identifier")
86                    }
87
88                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
89                        Ok(match v {
90                            "apiVersion" => Field::Key_api_version,
91                            "kind" => Field::Key_kind,
92                            "driverName" => Field::Key_driver_name,
93                            "metadata" => Field::Key_metadata,
94                            "parametersRef" => Field::Key_parameters_ref,
95                            "structuredParameters" => Field::Key_structured_parameters,
96                            "suitableNodes" => Field::Key_suitable_nodes,
97                            _ => Field::Other,
98                        })
99                    }
100                }
101
102                deserializer.deserialize_identifier(Visitor)
103            }
104        }
105
106        struct Visitor;
107
108        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
109            type Value = ResourceClass;
110
111            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
112                f.write_str(<Self::Value as crate::Resource>::KIND)
113            }
114
115            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
116                let mut value_driver_name: Option<std::string::String> = None;
117                let mut value_metadata: Option<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta> = None;
118                let mut value_parameters_ref: Option<crate::api::resource::v1alpha2::ResourceClassParametersReference> = None;
119                let mut value_structured_parameters: Option<bool> = None;
120                let mut value_suitable_nodes: Option<crate::api::core::v1::NodeSelector> = None;
121
122                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
123                    match key {
124                        Field::Key_api_version => {
125                            let value_api_version: std::string::String = crate::serde::de::MapAccess::next_value(&mut map)?;
126                            if value_api_version != <Self::Value as crate::Resource>::API_VERSION {
127                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_api_version), &<Self::Value as crate::Resource>::API_VERSION));
128                            }
129                        },
130                        Field::Key_kind => {
131                            let value_kind: std::string::String = crate::serde::de::MapAccess::next_value(&mut map)?;
132                            if value_kind != <Self::Value as crate::Resource>::KIND {
133                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_kind), &<Self::Value as crate::Resource>::KIND));
134                            }
135                        },
136                        Field::Key_driver_name => value_driver_name = crate::serde::de::MapAccess::next_value(&mut map)?,
137                        Field::Key_metadata => value_metadata = crate::serde::de::MapAccess::next_value(&mut map)?,
138                        Field::Key_parameters_ref => value_parameters_ref = crate::serde::de::MapAccess::next_value(&mut map)?,
139                        Field::Key_structured_parameters => value_structured_parameters = crate::serde::de::MapAccess::next_value(&mut map)?,
140                        Field::Key_suitable_nodes => value_suitable_nodes = crate::serde::de::MapAccess::next_value(&mut map)?,
141                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
142                    }
143                }
144
145                Ok(ResourceClass {
146                    driver_name: value_driver_name.unwrap_or_default(),
147                    metadata: value_metadata.unwrap_or_default(),
148                    parameters_ref: value_parameters_ref,
149                    structured_parameters: value_structured_parameters,
150                    suitable_nodes: value_suitable_nodes,
151                })
152            }
153        }
154
155        deserializer.deserialize_struct(
156            <Self as crate::Resource>::KIND,
157            &[
158                "apiVersion",
159                "kind",
160                "driverName",
161                "metadata",
162                "parametersRef",
163                "structuredParameters",
164                "suitableNodes",
165            ],
166            Visitor,
167        )
168    }
169}
170
171impl crate::serde::Serialize for ResourceClass {
172    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
173        let mut state = serializer.serialize_struct(
174            <Self as crate::Resource>::KIND,
175            4 +
176            self.parameters_ref.as_ref().map_or(0, |_| 1) +
177            self.structured_parameters.as_ref().map_or(0, |_| 1) +
178            self.suitable_nodes.as_ref().map_or(0, |_| 1),
179        )?;
180        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "apiVersion", <Self as crate::Resource>::API_VERSION)?;
181        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "kind", <Self as crate::Resource>::KIND)?;
182        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "driverName", &self.driver_name)?;
183        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "metadata", &self.metadata)?;
184        if let Some(value) = &self.parameters_ref {
185            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "parametersRef", value)?;
186        }
187        if let Some(value) = &self.structured_parameters {
188            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "structuredParameters", value)?;
189        }
190        if let Some(value) = &self.suitable_nodes {
191            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "suitableNodes", value)?;
192        }
193        crate::serde::ser::SerializeStruct::end(state)
194    }
195}
196
197#[cfg(feature = "schemars")]
198impl crate::schemars::JsonSchema for ResourceClass {
199    fn schema_name() -> std::borrow::Cow<'static, str> {
200        "io.k8s.api.resource.v1alpha2.ResourceClass".into()
201    }
202
203    fn json_schema(__gen: &mut crate::schemars::SchemaGenerator) -> crate::schemars::Schema {
204        crate::schemars::json_schema!({
205            "description": "ResourceClass is used by administrators to influence how resources are allocated.\n\nThis is an alpha type and requires enabling the DynamicResourceAllocation feature gate.",
206            "type": "object",
207            "properties": {
208                "apiVersion": {
209                    "description": "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",
210                    "type": "string",
211                },
212                "driverName": {
213                    "description": "DriverName defines the name of the dynamic resource driver that is used for allocation of a ResourceClaim that uses this class.\n\nResource drivers have a unique name in forward domain order (acme.example.com).",
214                    "type": "string",
215                },
216                "kind": {
217                    "description": "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",
218                    "type": "string",
219                },
220                "metadata": ({
221                    let mut schema_obj = __gen.subschema_for::<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta>();
222                    schema_obj.ensure_object().insert("description".into(), "Standard object metadata".into());
223                    schema_obj
224                }),
225                "parametersRef": ({
226                    let mut schema_obj = __gen.subschema_for::<crate::api::resource::v1alpha2::ResourceClassParametersReference>();
227                    schema_obj.ensure_object().insert("description".into(), "ParametersRef references an arbitrary separate object that may hold parameters that will be used by the driver when allocating a resource that uses this class. A dynamic resource driver can distinguish between parameters stored here and and those stored in ResourceClaimSpec.".into());
228                    schema_obj
229                }),
230                "structuredParameters": {
231                    "description": "If and only if allocation of claims using this class is handled via structured parameters, then StructuredParameters must be set to true.",
232                    "type": "boolean",
233                },
234                "suitableNodes": ({
235                    let mut schema_obj = __gen.subschema_for::<crate::api::core::v1::NodeSelector>();
236                    schema_obj.ensure_object().insert("description".into(), "Only nodes matching the selector will be considered by the scheduler when trying to find a Node that fits a Pod when that Pod uses a ResourceClaim that has not been allocated yet.\n\nSetting this field is optional. If null, all nodes are candidates.".into());
237                    schema_obj
238                }),
239            },
240            "required": [
241                "driverName",
242                "metadata",
243            ],
244        })
245    }
246}
k8s_openapi/v1_30/api/resource/v1alpha2/resource_class.rs

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