Struct DeviceRequest

pub struct DeviceRequest {
    pub admin_access: Option<bool>,
    pub allocation_mode: Option<String>,
    pub count: Option<i64>,
    pub device_class_name: String,
    pub name: String,
    pub selectors: Option<Vec<DeviceSelector>>,
}

DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.

A DeviceClassName is currently required. Clients must check that it is indeed set. It’s absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request.

Fields

admin_access: Option<bool>

AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations.

This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.

allocation_mode: Option<String>

AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:

• ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field.

• All: This request is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested.

If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.

More modes may get added in the future. Clients must refuse to handle requests with unknown modes.

count: Option<i64>

Count is used only when the count mode is “ExactCount”. Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.

device_class_name: String

DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.

A class is required. Which classes are available depends on the cluster.

Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.

name: String

Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.

Must be a DNS label.

selectors: Option<Vec<DeviceSelector>>

Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.

Trait Implementations

impl Clone for DeviceRequest

fn clone(&self) -> DeviceRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeviceRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeepMerge for DeviceRequest

fn merge_from(&mut self, other: Self)

Merge other into self.

impl Default for DeviceRequest

fn default() -> DeviceRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeviceRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeviceRequest

fn eq(&self, other: &DeviceRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeviceRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeviceRequest