java.lang.Object
- io.fabric8.kubernetes.api.model.resource.v1alpha3.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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`DeviceRequest()`	No args constructor for use in serialization
`DeviceRequest(Boolean adminAccess, String allocationMode, Long count, String deviceClassName, List<DeviceSubRequest> firstAvailable, String name, List<DeviceSelector> selectors, List<DeviceToleration> tolerations)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DeviceRequestBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`Boolean`	`getAdminAccess()`	AdminAccess indicates that this is a claim for administrative access to the device(s).
`String`	`getAllocationMode()`	AllocationMode and its related fields define how devices are allocated to satisfy this request.
`Long`	`getCount()`	Count is used only when the count mode is "ExactCount".
`String`	`getDeviceClassName()`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
`List<DeviceSubRequest>`	`getFirstAvailable()`	FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request.
`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.
`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.
`List<DeviceToleration>`	`getTolerations()`	If specified, the request's tolerations.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setAdminAccess(Boolean adminAccess)`	AdminAccess indicates that this is a claim for administrative access to the device(s).
`void`	`setAllocationMode(String allocationMode)`	AllocationMode and its related fields define how devices are allocated to satisfy this request.
`void`	`setCount(Long count)`	Count is used only when the count mode is "ExactCount".
`void`	`setDeviceClassName(String deviceClassName)`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
`void`	`setFirstAvailable(List<DeviceSubRequest> firstAvailable)`	FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request.
`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.
`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.
`void`	`setTolerations(List<DeviceToleration> tolerations)`	If specified, the request's tolerations.
`DeviceRequestBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DeviceRequest
```
public DeviceRequest()
```
    No args constructor for use in serialization
  - DeviceRequest
```
public DeviceRequest(Boolean adminAccess,
                     String allocationMode,
                     Long count,
                     String deviceClassName,
                     List<DeviceSubRequest> firstAvailable,
                     String name,
                     List<DeviceSelector> selectors,
                     List<DeviceToleration> tolerations)
```
- 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 field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
    
    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 field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
    
    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.
    At least one device must exist on the node for the allocation to succeed.
    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 requests must specify this field.
    
    This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
    
    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.
    At least one device must exist on the node for the allocation to succeed.
    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 requests must specify this field.
    
    This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
    
    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.
    
    This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
  - 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.
    
    This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
  - 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 if no subrequests are specified in the firstAvailable list and no class can be set if subrequests are specified in the firstAvailable list. 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 if no subrequests are specified in the firstAvailable list and no class can be set if subrequests are specified in the firstAvailable list. 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.
  - getFirstAvailable
```
public List<DeviceSubRequest> getFirstAvailable()
```
    FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request. It tries to satisfy them in the order in which they are listed here. So if there are two entries in the list, the scheduler will only check the second one if it determines that the first one cannot be used.
    
    This field may only be set in the entries of DeviceClaim.Requests.
    
    DRA does not yet implement scoring, so the scheduler will select the first set of devices that satisfies all the requests in the claim. And if the requirements can be satisfied on more than one node, other scheduling features will determine which node is chosen. This means that the set of devices allocated to a claim might not be the optimal set available to the cluster. Scoring will be implemented later.
  - setFirstAvailable
```
public void setFirstAvailable(List<DeviceSubRequest> firstAvailable)
```
    FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request. It tries to satisfy them in the order in which they are listed here. So if there are two entries in the list, the scheduler will only check the second one if it determines that the first one cannot be used.
    
    This field may only be set in the entries of DeviceClaim.Requests.
    
    DRA does not yet implement scoring, so the scheduler will select the first set of devices that satisfies all the requests in the claim. And if the requirements can be satisfied on more than one node, other scheduling features will determine which node is chosen. This means that the set of devices allocated to a claim might not be the optimal set available to the cluster. Scoring will be implemented later.
  - 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.
    
    This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
  - 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.
    
    This field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
  - 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 field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
    
    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 field can only be set when deviceClassName is set and no subrequests are specified in the firstAvailable list.
    
    This is an alpha field and requires enabling the DRADeviceTaints feature gate.
  - edit
```
public DeviceRequestBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<DeviceRequestBuilder>
  - toBuilder
```
public DeviceRequestBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class DeviceRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeviceRequest

DeviceRequest

Method Detail

getAdminAccess

setAdminAccess

getAllocationMode

setAllocationMode

getCount

setCount

getDeviceClassName

setDeviceClassName

getFirstAvailable

setFirstAvailable

getName

setName

getSelectors

setSelectors

getTolerations

setTolerations

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties