Package io.kubernetes.client.openapi.models

Class V1alpha3DeviceRequest

java.lang.Object
io.kubernetes.client.openapi.models.V1alpha3DeviceRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-02-04T19:05:53.712211Z[Etc/UTC]", comments="Generator version: 7.6.0") public class V1alpha3DeviceRequest 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. 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.

  • Field Details

  • Constructor Details

    • V1alpha3DeviceRequest

      public V1alpha3DeviceRequest()

  • Method Details

    • adminAccess

      public V1alpha3DeviceRequest adminAccess(Boolean adminAccess)

    • getAdminAccess

      @Nullable 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.
      Returns:
      adminAccess

    • setAdminAccess

      public void setAdminAccess(Boolean adminAccess)

    • allocationMode

      public V1alpha3DeviceRequest allocationMode(String allocationMode)

    • getAllocationMode

      @Nullable 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.
      Returns:
      allocationMode

    • setAllocationMode

      public void setAllocationMode(String allocationMode)

    • count

      public V1alpha3DeviceRequest count(Long count)

    • getCount

      @Nullable 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.
      Returns:
      count

    • setCount

      public void setCount(Long count)

    • deviceClassName

      public V1alpha3DeviceRequest deviceClassName(String deviceClassName)

    • getDeviceClassName

      @Nonnull 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.
      Returns:
      deviceClassName

    • setDeviceClassName

      public void setDeviceClassName(String deviceClassName)

    • name

      public V1alpha3DeviceRequest name(String name)

    • getName

      @Nonnull 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.
      Returns:
      name

    • setName

      public void setName(String name)

    • selectors

      public V1alpha3DeviceRequest selectors(List<V1alpha3DeviceSelector> selectors)

    • addSelectorsItem

      public V1alpha3DeviceRequest addSelectorsItem(V1alpha3DeviceSelector selectorsItem)

    • getSelectors

      @Nullable public List<V1alpha3DeviceSelector> 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.
      Returns:
      selectors

    • setSelectors

      public void setSelectors(List<V1alpha3DeviceSelector> selectors)

    • 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

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to V1alpha3DeviceRequest

    • fromJson

      public static V1alpha3DeviceRequest fromJson(String jsonString) throws IOException
      Create an instance of V1alpha3DeviceRequest given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of V1alpha3DeviceRequest
      Throws:
      IOException - if the JSON string is invalid with respect to V1alpha3DeviceRequest

    • toJson

      public String toJson()
      Convert an instance of V1alpha3DeviceRequest to an JSON string
      Returns:
      JSON string