scala-k8s-docs
0.22.0
API
Generated with
scala-k8s-docs/io.k8s/io.k8s.api/io.k8s.api.resource/io.k8s.api.resource.v1alpha3

io.k8s.api.resource.v1alpha3

package io.k8s.api.resource.v1alpha3

Members list

Type members

Classlikes

final case class AllocatedDeviceStatus(driver: String, pool: String, device: String, conditions: Option[Seq[Condition]], data: Option[RawExtension], networkData: Option[NetworkDeviceData])

AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it.

AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it. This may include driver-specific information.

Attributes

Companion
object
Source
AllocatedDeviceStatus.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AllocatedDeviceStatus

Attributes

Companion
class
Source
AllocatedDeviceStatus.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class AllocatedDeviceStatusPointer(currentPath: PointerPath) extends Pointer[AllocatedDeviceStatus]

Pointer for AllocatedDeviceStatus

Pointer for AllocatedDeviceStatus

Attributes

Source
AllocatedDeviceStatusPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class AllocationResult(devices: Option[DeviceAllocationResult], nodeSelector: Option[NodeSelector])

AllocationResult contains attributes of an allocated resource.

AllocationResult contains attributes of an allocated resource.

Attributes

Companion
object
Source
AllocationResult.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AllocationResult

Attributes

Companion
class
Source
AllocationResult.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class AllocationResultPointer(currentPath: PointerPath) extends Pointer[AllocationResult]

Pointer for AllocationResult

Pointer for AllocationResult

Attributes

Source
AllocationResultPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class BasicDevice(attributes: Option[Map[String, DeviceAttribute]], capacity: Option[Map[String, Quantity]])

BasicDevice defines one device instance.

BasicDevice defines one device instance.

Attributes

Companion
object
Source
BasicDevice.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BasicDevice

Attributes

Companion
class
Source
BasicDevice.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class BasicDevicePointer(currentPath: PointerPath) extends Pointer[BasicDevice]

Pointer for BasicDevice

Pointer for BasicDevice

Attributes

Source
BasicDevicePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CELDeviceSelector(expression: String)

CELDeviceSelector contains a CEL expression for selecting a device.

CELDeviceSelector contains a CEL expression for selecting a device.

Attributes

Companion
object
Source
CELDeviceSelector.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CELDeviceSelector

Attributes

Companion
class
Source
CELDeviceSelector.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CELDeviceSelectorPointer(currentPath: PointerPath) extends Pointer[CELDeviceSelector]

Pointer for CELDeviceSelector

Pointer for CELDeviceSelector

Attributes

Source
CELDeviceSelectorPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Device(name: String, basic: Option[BasicDevice])

Device represents one individual hardware instance that can be selected based on its attributes.

Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.

Attributes

Companion
object
Source
Device.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Device

Attributes

Companion
class
Source
Device.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Device.type
final case class DeviceAllocationConfiguration(source: String, opaque: Option[OpaqueDeviceConfiguration], requests: Option[Seq[String]])

DeviceAllocationConfiguration gets embedded in an AllocationResult.

DeviceAllocationConfiguration gets embedded in an AllocationResult.

Attributes

Companion
object
Source
DeviceAllocationConfiguration.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceAllocationConfiguration

Attributes

Companion
class
Source
DeviceAllocationConfiguration.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceAllocationConfigurationPointer(currentPath: PointerPath) extends Pointer[DeviceAllocationConfiguration]

Pointer for DeviceAllocationConfiguration

Pointer for DeviceAllocationConfiguration

Attributes

Source
DeviceAllocationConfigurationPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceAllocationResult(config: Option[Seq[DeviceAllocationConfiguration]], results: Option[Seq[DeviceRequestAllocationResult]])

DeviceAllocationResult is the result of allocating devices.

DeviceAllocationResult is the result of allocating devices.

Attributes

Companion
object
Source
DeviceAllocationResult.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceAllocationResult

Attributes

Companion
class
Source
DeviceAllocationResult.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceAllocationResultPointer(currentPath: PointerPath) extends Pointer[DeviceAllocationResult]

Pointer for DeviceAllocationResult

Pointer for DeviceAllocationResult

Attributes

Source
DeviceAllocationResultPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceAttribute(bool: Option[Boolean], int: Option[Long], string: Option[String], version: Option[String])

DeviceAttribute must have exactly one field set.

DeviceAttribute must have exactly one field set.

Attributes

Companion
object
Source
DeviceAttribute.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceAttribute

Attributes

Companion
class
Source
DeviceAttribute.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceAttributePointer(currentPath: PointerPath) extends Pointer[DeviceAttribute]

Pointer for DeviceAttribute

Pointer for DeviceAttribute

Attributes

Source
DeviceAttributePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceClaim(config: Option[Seq[DeviceClaimConfiguration]], constraints: Option[Seq[DeviceConstraint]], requests: Option[Seq[DeviceRequest]])

DeviceClaim defines how to request devices with a ResourceClaim.

DeviceClaim defines how to request devices with a ResourceClaim.

Attributes

Companion
object
Source
DeviceClaim.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceClaim

Attributes

Companion
class
Source
DeviceClaim.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceClaimConfiguration(opaque: Option[OpaqueDeviceConfiguration], requests: Option[Seq[String]])

DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.

DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.

Attributes

Companion
object
Source
DeviceClaimConfiguration.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceClaimConfiguration

Attributes

Companion
class
Source
DeviceClaimConfiguration.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceClaimConfigurationPointer(currentPath: PointerPath) extends Pointer[DeviceClaimConfiguration]

Pointer for DeviceClaimConfiguration

Pointer for DeviceClaimConfiguration

Attributes

Source
DeviceClaimConfigurationPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceClaimPointer(currentPath: PointerPath) extends Pointer[DeviceClaim]

Pointer for DeviceClaim

Pointer for DeviceClaim

Attributes

Source
DeviceClaimPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceClass(spec: DeviceClassSpec, metadata: Option[ObjectMeta]) extends KObject

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors.

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors. It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Attributes

Companion
object
Source
DeviceClass.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object DeviceClass

Attributes

Companion
class
Source
DeviceClass.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceClassConfiguration(opaque: Option[OpaqueDeviceConfiguration])

DeviceClassConfiguration is used in DeviceClass.

DeviceClassConfiguration is used in DeviceClass.

Attributes

Companion
object
Source
DeviceClassConfiguration.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceClassConfiguration

Attributes

Companion
class
Source
DeviceClassConfiguration.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceClassConfigurationPointer(currentPath: PointerPath) extends Pointer[DeviceClassConfiguration]

Pointer for DeviceClassConfiguration

Pointer for DeviceClassConfiguration

Attributes

Source
DeviceClassConfigurationPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceClassList(items: Seq[DeviceClass], metadata: Option[ListMeta]) extends KObject

DeviceClassList is a collection of classes.

DeviceClassList is a collection of classes.

Attributes

Companion
object
Source
DeviceClassList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object DeviceClassList

Attributes

Companion
class
Source
DeviceClassList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceClassListPointer(currentPath: PointerPath) extends Pointer[DeviceClassList]

Pointer for DeviceClassList

Pointer for DeviceClassList

Attributes

Source
DeviceClassListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceClassPointer(currentPath: PointerPath) extends Pointer[DeviceClass]

Pointer for DeviceClass

Pointer for DeviceClass

Attributes

Source
DeviceClassPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceClassSpec(config: Option[Seq[DeviceClassConfiguration]], selectors: Option[Seq[DeviceSelector]])

DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.

DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.

Attributes

Companion
object
Source
DeviceClassSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceClassSpec

Attributes

Companion
class
Source
DeviceClassSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceClassSpecPointer(currentPath: PointerPath) extends Pointer[DeviceClassSpec]

Pointer for DeviceClassSpec

Pointer for DeviceClassSpec

Attributes

Source
DeviceClassSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceConstraint(matchAttribute: Option[String], requests: Option[Seq[String]])

DeviceConstraint must have exactly one field set besides Requests.

DeviceConstraint must have exactly one field set besides Requests.

Attributes

Companion
object
Source
DeviceConstraint.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceConstraint

Attributes

Companion
class
Source
DeviceConstraint.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceConstraintPointer(currentPath: PointerPath) extends Pointer[DeviceConstraint]

Pointer for DeviceConstraint

Pointer for DeviceConstraint

Attributes

Source
DeviceConstraintPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DevicePointer(currentPath: PointerPath) extends Pointer[Device]

Pointer for Device

Pointer for Device

Attributes

Source
DevicePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Pointer[Device]
class Object
trait Matchable
class Any
Show all
final case class DeviceRequest(name: String, deviceClassName: String, count: Option[Long], adminAccess: Option[Boolean], selectors: Option[Seq[DeviceSelector]], allocationMode: Option[String])

DeviceRequest is a request for devices required for a claim.

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.

Attributes

Companion
object
Source
DeviceRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceRequest

Attributes

Companion
class
Source
DeviceRequest.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceRequestAllocationResult(request: String, driver: String, pool: String, device: String, adminAccess: Option[Boolean])

DeviceRequestAllocationResult contains the allocation result for one request.

DeviceRequestAllocationResult contains the allocation result for one request.

Attributes

Companion
object
Source
DeviceRequestAllocationResult.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceRequestAllocationResult

Attributes

Companion
class
Source
DeviceRequestAllocationResult.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceRequestAllocationResultPointer(currentPath: PointerPath) extends Pointer[DeviceRequestAllocationResult]

Pointer for DeviceRequestAllocationResult

Pointer for DeviceRequestAllocationResult

Attributes

Source
DeviceRequestAllocationResultPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceRequestPointer(currentPath: PointerPath) extends Pointer[DeviceRequest]

Pointer for DeviceRequest

Pointer for DeviceRequest

Attributes

Source
DeviceRequestPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DeviceSelector(cel: Option[CELDeviceSelector])

DeviceSelector must have exactly one field set.

DeviceSelector must have exactly one field set.

Attributes

Companion
object
Source
DeviceSelector.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeviceSelector

Attributes

Companion
class
Source
DeviceSelector.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DeviceSelectorPointer(currentPath: PointerPath) extends Pointer[DeviceSelector]

Pointer for DeviceSelector

Pointer for DeviceSelector

Attributes

Source
DeviceSelectorPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class NetworkDeviceData(hardwareAddress: Option[String], interfaceName: Option[String], ips: Option[Seq[String]])

NetworkDeviceData provides network-related details for the allocated device.

NetworkDeviceData provides network-related details for the allocated device. This information may be filled by drivers or other components to configure or identify the device within a network context.

Attributes

Companion
object
Source
NetworkDeviceData.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkDeviceData

Attributes

Companion
class
Source
NetworkDeviceData.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class NetworkDeviceDataPointer(currentPath: PointerPath) extends Pointer[NetworkDeviceData]

Pointer for NetworkDeviceData

Pointer for NetworkDeviceData

Attributes

Source
NetworkDeviceDataPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class OpaqueDeviceConfiguration(driver: String, parameters: RawExtension)

OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.

OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.

Attributes

Companion
object
Source
OpaqueDeviceConfiguration.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OpaqueDeviceConfiguration

Attributes

Companion
class
Source
OpaqueDeviceConfiguration.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class OpaqueDeviceConfigurationPointer(currentPath: PointerPath) extends Pointer[OpaqueDeviceConfiguration]

Pointer for OpaqueDeviceConfiguration

Pointer for OpaqueDeviceConfiguration

Attributes

Source
OpaqueDeviceConfigurationPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaim(spec: ResourceClaimSpec, status: Option[ResourceClaimStatus], metadata: Option[ObjectMeta]) extends KObject

ResourceClaim describes a request for access to resources in the cluster, for use by workloads.

ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Attributes

Companion
object
Source
ResourceClaim.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object ResourceClaim

Attributes

Companion
class
Source
ResourceClaim.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimConsumerReference(name: String, resource: String, uid: String, apiGroup: Option[String])

ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim.

ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.

Attributes

Companion
object
Source
ResourceClaimConsumerReference.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceClaimConsumerReference

Attributes

Companion
class
Source
ResourceClaimConsumerReference.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimConsumerReferencePointer(currentPath: PointerPath) extends Pointer[ResourceClaimConsumerReference]

Pointer for ResourceClaimConsumerReference

Pointer for ResourceClaimConsumerReference

Attributes

Source
ResourceClaimConsumerReferencePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimList(items: Seq[ResourceClaim], metadata: Option[ListMeta]) extends KObject

ResourceClaimList is a collection of claims.

ResourceClaimList is a collection of claims.

Attributes

Companion
object
Source
ResourceClaimList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object ResourceClaimList

Attributes

Companion
class
Source
ResourceClaimList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimListPointer(currentPath: PointerPath) extends Pointer[ResourceClaimList]

Pointer for ResourceClaimList

Pointer for ResourceClaimList

Attributes

Source
ResourceClaimListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimPointer(currentPath: PointerPath) extends Pointer[ResourceClaim]

Pointer for ResourceClaim

Pointer for ResourceClaim

Attributes

Source
ResourceClaimPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimSpec(devices: Option[DeviceClaim])

ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.

ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.

Attributes

Companion
object
Source
ResourceClaimSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceClaimSpec

Attributes

Companion
class
Source
ResourceClaimSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimSpecPointer(currentPath: PointerPath) extends Pointer[ResourceClaimSpec]

Pointer for ResourceClaimSpec

Pointer for ResourceClaimSpec

Attributes

Source
ResourceClaimSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimStatus(allocation: Option[AllocationResult], devices: Option[Seq[AllocatedDeviceStatus]], reservedFor: Option[Seq[ResourceClaimConsumerReference]])

ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.

ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.

Attributes

Companion
object
Source
ResourceClaimStatus.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceClaimStatus

Attributes

Companion
class
Source
ResourceClaimStatus.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimStatusPointer(currentPath: PointerPath) extends Pointer[ResourceClaimStatus]

Pointer for ResourceClaimStatus

Pointer for ResourceClaimStatus

Attributes

Source
ResourceClaimStatusPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimTemplate(spec: ResourceClaimTemplateSpec, metadata: Option[ObjectMeta]) extends KObject

ResourceClaimTemplate is used to produce ResourceClaim objects.

ResourceClaimTemplate is used to produce ResourceClaim objects.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Attributes

Companion
object
Source
ResourceClaimTemplate.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object ResourceClaimTemplate

Attributes

Companion
class
Source
ResourceClaimTemplate.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimTemplateList(items: Seq[ResourceClaimTemplate], metadata: Option[ListMeta]) extends KObject

ResourceClaimTemplateList is a collection of claim templates.

ResourceClaimTemplateList is a collection of claim templates.

Attributes

Companion
object
Source
ResourceClaimTemplateList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object ResourceClaimTemplateList

Attributes

Companion
class
Source
ResourceClaimTemplateList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimTemplateListPointer(currentPath: PointerPath) extends Pointer[ResourceClaimTemplateList]

Pointer for ResourceClaimTemplateList

Pointer for ResourceClaimTemplateList

Attributes

Source
ResourceClaimTemplateListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimTemplatePointer(currentPath: PointerPath) extends Pointer[ResourceClaimTemplate]

Pointer for ResourceClaimTemplate

Pointer for ResourceClaimTemplate

Attributes

Source
ResourceClaimTemplatePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceClaimTemplateSpec(spec: ResourceClaimSpec, metadata: Option[ObjectMeta])

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

Attributes

Companion
object
Source
ResourceClaimTemplateSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceClaimTemplateSpec

Attributes

Companion
class
Source
ResourceClaimTemplateSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceClaimTemplateSpecPointer(currentPath: PointerPath) extends Pointer[ResourceClaimTemplateSpec]

Pointer for ResourceClaimTemplateSpec

Pointer for ResourceClaimTemplateSpec

Attributes

Source
ResourceClaimTemplateSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourcePool(generation: Long, name: String, resourceSliceCount: Long)

ResourcePool describes the pool that ResourceSlices belong to.

ResourcePool describes the pool that ResourceSlices belong to.

Attributes

Companion
object
Source
ResourcePool.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourcePool

Attributes

Companion
class
Source
ResourcePool.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourcePoolPointer(currentPath: PointerPath) extends Pointer[ResourcePool]

Pointer for ResourcePool

Pointer for ResourcePool

Attributes

Source
ResourcePoolPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceSlice(spec: ResourceSliceSpec, metadata: Option[ObjectMeta]) extends KObject

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver.

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.

At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple <driver name>, <pool name>, <device name>.

Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.

When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.

For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Attributes

Companion
object
Source
ResourceSlice.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object ResourceSlice

Attributes

Companion
class
Source
ResourceSlice.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceSliceList(items: Seq[ResourceSlice], metadata: Option[ListMeta]) extends KObject

ResourceSliceList is a collection of ResourceSlices.

ResourceSliceList is a collection of ResourceSlices.

Attributes

Companion
object
Source
ResourceSliceList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object ResourceSliceList

Attributes

Companion
class
Source
ResourceSliceList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceSliceListPointer(currentPath: PointerPath) extends Pointer[ResourceSliceList]

Pointer for ResourceSliceList

Pointer for ResourceSliceList

Attributes

Source
ResourceSliceListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceSlicePointer(currentPath: PointerPath) extends Pointer[ResourceSlice]

Pointer for ResourceSlice

Pointer for ResourceSlice

Attributes

Source
ResourceSlicePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ResourceSliceSpec(driver: String, pool: ResourcePool, nodeName: Option[String], nodeSelector: Option[NodeSelector], allNodes: Option[Boolean], devices: Option[Seq[Device]])

ResourceSliceSpec contains the information published by the driver in one ResourceSlice.

ResourceSliceSpec contains the information published by the driver in one ResourceSlice.

Attributes

Companion
object
Source
ResourceSliceSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceSliceSpec

Attributes

Companion
class
Source
ResourceSliceSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ResourceSliceSpecPointer(currentPath: PointerPath) extends Pointer[ResourceSliceSpec]

Pointer for ResourceSliceSpec

Pointer for ResourceSliceSpec

Attributes

Source
ResourceSliceSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with