Package io.fabric8.kubernetes.api.model.resource.v1alpha3

Class DeviceRequest

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<DeviceRequestBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class DeviceRequest
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<DeviceRequestBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    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.

    See Also:
    Serialized Form

    • Constructor Detail

      • DeviceRequest

        public DeviceRequest()
        No args constructor for use in serialization

    • Method Detail

      • getAdminAccess

        public Boolean getAdminAccess()
        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.

      • setAdminAccess

        public void setAdminAccess​(Boolean adminAccess)
        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.

      • getAllocationMode

        public String getAllocationMode()
        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.

      • setAllocationMode

        public void setAllocationMode​(String allocationMode)
        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.

      • getCount

        public Long getCount()
        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.

      • setCount

        public void setCount​(Long count)
        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.

      • getDeviceClassName

        public String getDeviceClassName()
        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.

      • setDeviceClassName

        public void setDeviceClassName​(String deviceClassName)
        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.

      • getName

        public String getName()
        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.

      • setName

        public void setName​(String name)
        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.

      • getSelectors

        public List<DeviceSelector> getSelectors()
        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.

      • setSelectors

        public void setSelectors​(List<DeviceSelector> selectors)
        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.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)