#
k8s_openapi/v1_35/api/resource/v1beta1/
resource_slice.rs

    1// Generated from definition io.k8s.api.resource.v1beta1.ResourceSlice
    2
    3/// ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.
    4///
    5/// At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple \<driver name\>, \<pool name\>, \<device name\>.
    6///
    7/// Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.
    8///
    9/// When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.
    10///
    11/// For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.
    12///
    13/// This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
    14#[derive(Clone, Debug, Default, PartialEq)]
    15pub struct ResourceSlice {
    16    /// Standard object metadata
    17    pub metadata: crate::apimachinery::pkg::apis::meta::v1::ObjectMeta,
    18
    19    /// Contains the information published by the driver.
    20    ///
    21    /// Changing the spec automatically increments the metadata.generation number.
    22    pub spec: crate::api::resource::v1beta1::ResourceSliceSpec,
    23}
    24
    25impl crate::Resource for ResourceSlice {
    26    const API_VERSION: &'static str = "resource.k8s.io/v1beta1";
    27    const GROUP: &'static str = "resource.k8s.io";
    28    const KIND: &'static str = "ResourceSlice";
    29    const VERSION: &'static str = "v1beta1";
    30    const URL_PATH_SEGMENT: &'static str = "resourceslices";
    31    type Scope = crate::ClusterResourceScope;
    32}
    33
    34impl crate::ListableResource for ResourceSlice {
    35    const LIST_KIND: &'static str = "ResourceSliceList";
    36}
    37
    38impl crate::Metadata for ResourceSlice {
    39    type Ty = crate::apimachinery::pkg::apis::meta::v1::ObjectMeta;
    40
    41    fn metadata(&self) -> &<Self as crate::Metadata>::Ty {
    42        &self.metadata
    43    }
    44
    45    fn metadata_mut(&mut self) -> &mut<Self as crate::Metadata>::Ty {
    46        &mut self.metadata
    47    }
    48}
    49
    50impl crate::DeepMerge for ResourceSlice {
    51    fn merge_from(&mut self, other: Self) {
    52        crate::DeepMerge::merge_from(&mut self.metadata, other.metadata);
    53        crate::DeepMerge::merge_from(&mut self.spec, other.spec);
    54    }
    55}
    56
    57impl<'de> crate::serde::Deserialize<'de> for ResourceSlice {
    58    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
    59        #[allow(non_camel_case_types)]
    60        enum Field {
    61            Key_api_version,
    62            Key_kind,
    63            Key_metadata,
    64            Key_spec,
    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 core::fmt::Formatter<'_>) -> core::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                            "metadata" => Field::Key_metadata,
    84                            "spec" => Field::Key_spec,
    85                            _ => Field::Other,
    86                        })
    87                    }
    88                }
    89
    90                deserializer.deserialize_identifier(Visitor)
    91            }
    92        }
    93
    94        struct Visitor;
    95
    96        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
    97            type Value = ResourceSlice;
    98
    99            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    100                f.write_str(<Self::Value as crate::Resource>::KIND)
    101            }
    102
    103            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
    104                let mut value_metadata: Option<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta> = None;
    105                let mut value_spec: Option<crate::api::resource::v1beta1::ResourceSliceSpec> = None;
    106
    107                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
    108                    match key {
    109                        Field::Key_api_version => {
    110                            let value_api_version: std::string::String = crate::serde::de::MapAccess::next_value(&mut map)?;
    111                            if value_api_version != <Self::Value as crate::Resource>::API_VERSION {
    112                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_api_version), &<Self::Value as crate::Resource>::API_VERSION));
    113                            }
    114                        },
    115                        Field::Key_kind => {
    116                            let value_kind: std::string::String = crate::serde::de::MapAccess::next_value(&mut map)?;
    117                            if value_kind != <Self::Value as crate::Resource>::KIND {
    118                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_kind), &<Self::Value as crate::Resource>::KIND));
    119                            }
    120                        },
    121                        Field::Key_metadata => value_metadata = crate::serde::de::MapAccess::next_value(&mut map)?,
    122                        Field::Key_spec => value_spec = 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(ResourceSlice {
    128                    metadata: value_metadata.unwrap_or_default(),
    129                    spec: value_spec.unwrap_or_default(),
    130                })
    131            }
    132        }
    133
    134        deserializer.deserialize_struct(
    135            <Self as crate::Resource>::KIND,
    136            &[
    137                "apiVersion",
    138                "kind",
    139                "metadata",
    140                "spec",
    141            ],
    142            Visitor,
    143        )
    144    }
    145}
    146
    147impl crate::serde::Serialize for ResourceSlice {
    148    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
    149        let mut state = serializer.serialize_struct(
    150            <Self as crate::Resource>::KIND,
    151            4,
    152        )?;
    153        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "apiVersion", <Self as crate::Resource>::API_VERSION)?;
    154        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "kind", <Self as crate::Resource>::KIND)?;
    155        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "metadata", &self.metadata)?;
    156        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "spec", &self.spec)?;
    157        crate::serde::ser::SerializeStruct::end(state)
    158    }
    159}
    160
    161#[cfg(feature = "schemars")]
    162impl crate::schemars::JsonSchema for ResourceSlice {
    163    fn schema_name() -> std::borrow::Cow<'static, str> {
    164        "io.k8s.api.resource.v1beta1.ResourceSlice".into()
    165    }
    166
    167    fn json_schema(__gen: &mut crate::schemars::SchemaGenerator) -> crate::schemars::Schema {
    168        crate::schemars::json_schema!({
    169            "description": "ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.\n\nAt the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple <driver name>, <pool name>, <device name>.\n\nWhenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.\n\nWhen allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.\n\nFor resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.\n\nThis is an alpha type and requires enabling the DynamicResourceAllocation feature gate.",
    170            "type": "object",
    171            "properties": {
    172                "apiVersion": {
    173                    "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",
    174                    "type": "string",
    175                },
    176                "kind": {
    177                    "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",
    178                    "type": "string",
    179                },
    180                "metadata": ({
    181                    let mut schema_obj = __gen.subschema_for::<crate::apimachinery::pkg::apis::meta::v1::ObjectMeta>();
    182                    schema_obj.ensure_object().insert("description".into(), "Standard object metadata".into());
    183                    schema_obj
    184                }),
    185                "spec": ({
    186                    let mut schema_obj = __gen.subschema_for::<crate::api::resource::v1beta1::ResourceSliceSpec>();
    187                    schema_obj.ensure_object().insert("description".into(), "Contains the information published by the driver.\n\nChanging the spec automatically increments the metadata.generation number.".into());
    188                    schema_obj
    189                }),
    190            },
    191            "required": [
    192                "metadata",
    193                "spec",
    194            ],
    195        })
    196    }
    197}