1// Generated from definition io.k8s.api.resource.v1beta2.CELDeviceSelector
23/// CELDeviceSelector contains a CEL expression for selecting a device.
4#[derive(Clone, Debug, Default, PartialEq)]
5pub struct CELDeviceSelector {
6/// Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort.
7 ///
8 /// The expression's input is an object named "device", which carries the following properties:
9 /// - driver (string): the name of the driver which defines this device.
10 /// - attributes (map\[string\]object): the device's attributes, grouped by prefix
11 /// (e.g. device.attributes\["dra.example.com"\] evaluates to an object with all
12 /// of the attributes which were prefixed by "dra.example.com".
13 /// - capacity (map\[string\]object): the device's capacities, grouped by prefix.
14 ///
15 /// Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields:
16 ///
17 /// device.driver
18 /// device.attributes\["dra.example.com"\].model
19 /// device.attributes\["ext.example.com"\].family
20 /// device.capacity\["dra.example.com"\].modules
21 ///
22 /// The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers.
23 ///
24 /// The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity.
25 ///
26 /// If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort.
27 ///
28 /// A robust expression should check for the existence of attributes before referencing them.
29 ///
30 /// For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example:
31 ///
32 /// cel.bind(dra, device.attributes\["dra.example.com"\], dra.someBool && dra.anotherBool)
33 ///
34 /// The length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps.
35pub expression: std::string::String,
36}
3738impl crate::DeepMerge for CELDeviceSelector {
39fn merge_from(&mut self, other: Self) {
40crate::DeepMerge::merge_from(&mut self.expression, other.expression);
41 }
42}
4344impl<'de> crate::serde::Deserialize<'de> for CELDeviceSelector {
45fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
46#[allow(non_camel_case_types)]
47enum Field {
48 Key_expression,
49 Other,
50 }
5152impl<'de> crate::serde::Deserialize<'de> for Field {
53fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
54struct Visitor;
5556impl crate::serde::de::Visitor<'_> for Visitor {
57type Value = Field;
5859fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
60 f.write_str("field identifier")
61 }
6263fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
64Ok(match v {
65"expression" => Field::Key_expression,
66_ => Field::Other,
67 })
68 }
69 }
7071 deserializer.deserialize_identifier(Visitor)
72 }
73 }
7475struct Visitor;
7677impl<'de> crate::serde::de::Visitor<'de> for Visitor {
78type Value = CELDeviceSelector;
7980fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
81 f.write_str("CELDeviceSelector")
82 }
8384fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
85let mut value_expression: Option<std::string::String> = None;
8687while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
88match key {
89 Field::Key_expression => value_expression = crate::serde::de::MapAccess::next_value(&mut map)?,
90 Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
91 }
92 }
9394Ok(CELDeviceSelector {
95 expression: value_expression.unwrap_or_default(),
96 })
97 }
98 }
99100 deserializer.deserialize_struct(
101"CELDeviceSelector",
102&[
103"expression",
104 ],
105 Visitor,
106 )
107 }
108}
109110impl crate::serde::Serialize for CELDeviceSelector {
111fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
112let mut state = serializer.serialize_struct(
113"CELDeviceSelector",
1141,
115 )?;
116crate::serde::ser::SerializeStruct::serialize_field(&mut state, "expression", &self.expression)?;
117crate::serde::ser::SerializeStruct::end(state)
118 }
119}
120121#[cfg(feature = "schemars")]
122impl crate::schemars::JsonSchema for CELDeviceSelector {
123fn schema_name() -> std::string::String {
124"io.k8s.api.resource.v1beta2.CELDeviceSelector".into()
125 }
126127fn json_schema(__gen: &mut crate::schemars::gen::SchemaGenerator) -> crate::schemars::schema::Schema {
128crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
129 metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
130 description: Some("CELDeviceSelector contains a CEL expression for selecting a device.".into()),
131 ..Default::default()
132 })),
133 instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::Object))),
134 object: Some(std::boxed::Box::new(crate::schemars::schema::ObjectValidation {
135 properties: [
136 (
137"expression".into(),
138crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
139 metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
140 description: Some("Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort.\n\nThe expression's input is an object named \"device\", which carries the following properties:\n - driver (string): the name of the driver which defines this device.\n - attributes (map[string]object): the device's attributes, grouped by prefix\n (e.g. device.attributes[\"dra.example.com\"] evaluates to an object with all\n of the attributes which were prefixed by \"dra.example.com\".\n - capacity (map[string]object): the device's capacities, grouped by prefix.\n\nExample: Consider a device with driver=\"dra.example.com\", which exposes two attributes named \"model\" and \"ext.example.com/family\" and which exposes one capacity named \"modules\". This input to this expression would have the following fields:\n\n device.driver\n device.attributes[\"dra.example.com\"].model\n device.attributes[\"ext.example.com\"].family\n device.capacity[\"dra.example.com\"].modules\n\nThe device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers.\n\nThe value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity.\n\nIf an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort.\n\nA robust expression should check for the existence of attributes before referencing them.\n\nFor ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example:\n\n cel.bind(dra, device.attributes[\"dra.example.com\"], dra.someBool && dra.anotherBool)\n\nThe length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps.".into()),
141 ..Default::default()
142 })),
143 instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::String))),
144 ..Default::default()
145 }),
146 ),
147 ].into(),
148 required: [
149"expression".into(),
150 ].into(),
151 ..Default::default()
152 })),
153 ..Default::default()
154 })
155 }
156}