Packages > pkg.pkl-lang.org/pkl-k8s/k8s > k8s.api.resource.v1alpha3.ResourceClaimSpec

DeviceRequest1.2.1

Overview
Properties
Methods

class DeviceRequest

DeviceRequest is a request for devices required for a claim.

Known subtypes:
Known usages:: DeviceClaim
All versions:: 1.2.1, 1.2.0

Properties

link
allocationMode: String?Source

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.
link

deviceClassName: String Source

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.
link

adminAccess: Boolean?Source

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.
link

count: Int?Source

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.
link

name: String Source

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.
link

selectors: Listing<DeviceSelector>?Source

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.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.