Package io.micronaut.kubernetes.client.openapi.model

Class V1beta1DeviceRequest

java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1beta1DeviceRequest
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen") public class V1beta1DeviceRequest extends Object
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.

  • Field Details

  • Constructor Details

    • V1beta1DeviceRequest

      public V1beta1DeviceRequest(String name)

  • Method Details

    • 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 and unique among all DeviceRequests in a ResourceClaim.
      Returns:
      the name property value

    • setName

      public void setName(String name)
      Set the name property value
      Parameters:
      name - property value to set

    • name

      public V1beta1DeviceRequest name(String name)
      Set name in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • 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.
      Returns:
      the adminAccess property value

    • setAdminAccess

      public void setAdminAccess(Boolean adminAccess)
      Set the adminAccess property value
      Parameters:
      adminAccess - property value to set

    • adminAccess

      public V1beta1DeviceRequest adminAccess(Boolean adminAccess)
      Set adminAccess in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • 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.
      Returns:
      the allocationMode property value

    • setAllocationMode

      public void setAllocationMode(String allocationMode)
      Set the allocationMode property value
      Parameters:
      allocationMode - property value to set

    • allocationMode

      public V1beta1DeviceRequest allocationMode(String allocationMode)
      Set allocationMode in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • 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.
      Returns:
      the count property value

    • setCount

      public void setCount(Long count)
      Set the count property value
      Parameters:
      count - property value to set

    • count

      public V1beta1DeviceRequest count(Long count)
      Set count in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • 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.
      Returns:
      the deviceClassName property value

    • setDeviceClassName

      public void setDeviceClassName(String deviceClassName)
      Set the deviceClassName property value
      Parameters:
      deviceClassName - property value to set

    • deviceClassName

      public V1beta1DeviceRequest deviceClassName(String deviceClassName)
      Set deviceClassName in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • getFirstAvailable

      public List<@Valid V1beta1DeviceSubRequest> 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.
      Returns:
      the firstAvailable property value

    • setFirstAvailable

      public void setFirstAvailable(List<@Valid V1beta1DeviceSubRequest> firstAvailable)
      Set the firstAvailable property value
      Parameters:
      firstAvailable - property value to set

    • firstAvailable

      public V1beta1DeviceRequest firstAvailable(List<@Valid V1beta1DeviceSubRequest> firstAvailable)
      Set firstAvailable in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • addFirstAvailableItem

      public V1beta1DeviceRequest addFirstAvailableItem(V1beta1DeviceSubRequest firstAvailableItem)
      Add an item to the firstAvailable property in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • getSelectors

      public List<@Valid V1beta1DeviceSelector> 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.
      Returns:
      the selectors property value

    • setSelectors

      public void setSelectors(List<@Valid V1beta1DeviceSelector> selectors)
      Set the selectors property value
      Parameters:
      selectors - property value to set

    • selectors

      public V1beta1DeviceRequest selectors(List<@Valid V1beta1DeviceSelector> selectors)
      Set selectors in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • addSelectorsItem

      public V1beta1DeviceRequest addSelectorsItem(V1beta1DeviceSelector selectorsItem)
      Add an item to the selectors property in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • getTolerations

      public List<@Valid V1beta1DeviceToleration> 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.
      Returns:
      the tolerations property value

    • setTolerations

      public void setTolerations(List<@Valid V1beta1DeviceToleration> tolerations)
      Set the tolerations property value
      Parameters:
      tolerations - property value to set

    • tolerations

      public V1beta1DeviceRequest tolerations(List<@Valid V1beta1DeviceToleration> tolerations)
      Set tolerations in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • addTolerationsItem

      public V1beta1DeviceRequest addTolerationsItem(V1beta1DeviceToleration tolerationsItem)
      Add an item to the tolerations property in a chainable fashion.
      Returns:
      The same instance of V1beta1DeviceRequest for chaining.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object