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

Class DeviceSubRequest

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<DeviceSubRequestBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class DeviceSubRequest
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<DeviceSubRequestBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices.


    DeviceSubRequest is similar to Request, but doesn't expose the AdminAccess or FirstAvailable fields, as those can only be set on the top-level request. AdminAccess is not supported for requests with a prioritized list, and recursive FirstAvailable fields are not supported.

    See Also:
    Serialized Form

    • Method Detail

      • getAllocationMode

        public String getAllocationMode()
        AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. 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 subrequest is for all of the matching devices in a pool.

        Allocation will fail if some devices are already allocated,

        unless adminAccess is requested.


        If AllocationMode 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 subrequests 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 subrequest. 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 subrequest is for all of the matching devices in a pool.

        Allocation will fail if some devices are already allocated,

        unless adminAccess is requested.


        If AllocationMode 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 subrequests 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 subrequest.


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


        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 subrequest in the list of constraints or the list of configurations for the claim. References must use the format <main request>/<subrequest>.


        Must be a DNS label.

      • setName

        public void setName​(String name)
        Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format <main request>/<subrequest>.


        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 subrequest. 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 subrequest. All selectors must be satisfied for a device to be considered.

      • getTolerations

        public List<DeviceToleration> getTolerations()
        If specified, the request's tolerations.


        Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute.


        In addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated.


        The maximum number of tolerations is 16.


        This is an alpha field and requires enabling the DRADeviceTaints feature gate.

      • setTolerations

        public void setTolerations​(List<DeviceToleration> tolerations)
        If specified, the request's tolerations.


        Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute.


        In addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated.


        The maximum number of tolerations is 16.


        This is an alpha field and requires enabling the DRADeviceTaints feature gate.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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