Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package api contains a variant of the API where strings are unique. These unique strings are faster to compare and more efficient when used as key in a map.
+k8s:conversion-gen=k8s.io/api/resource/v1
Index ¶
- Variables
 - func Convert_api_CapacityRequestPolicyRange_To_v1_CapacityRequestPolicyRange(in *CapacityRequestPolicyRange, out *v1.CapacityRequestPolicyRange, ...) error
 - func Convert_api_CapacityRequestPolicy_To_v1_CapacityRequestPolicy(in *CapacityRequestPolicy, out *v1.CapacityRequestPolicy, s conversion.Scope) error
 - func Convert_api_CounterSet_To_v1_CounterSet(in *CounterSet, out *v1.CounterSet, s conversion.Scope) error
 - func Convert_api_Counter_To_v1_Counter(in *Counter, out *v1.Counter, s conversion.Scope) error
 - func Convert_api_DeviceAttribute_To_v1_DeviceAttribute(in *DeviceAttribute, out *v1.DeviceAttribute, s conversion.Scope) error
 - func Convert_api_DeviceCapacity_To_v1_DeviceCapacity(in *DeviceCapacity, out *v1.DeviceCapacity, s conversion.Scope) error
 - func Convert_api_DeviceCounterConsumption_To_v1_DeviceCounterConsumption(in *DeviceCounterConsumption, out *v1.DeviceCounterConsumption, ...) error
 - func Convert_api_DeviceTaint_To_v1_DeviceTaint(in *DeviceTaint, out *v1.DeviceTaint, s conversion.Scope) error
 - func Convert_api_Device_To_v1_Device(in *Device, out *v1.Device, s conversion.Scope) error
 - func Convert_api_ResourcePool_To_v1_ResourcePool(in *ResourcePool, out *v1.ResourcePool, s conversion.Scope) error
 - func Convert_api_ResourceSliceSpec_To_v1_ResourceSliceSpec(in *ResourceSliceSpec, out *v1.ResourceSliceSpec, s conversion.Scope) error
 - func Convert_api_ResourceSlice_To_v1_ResourceSlice(in *ResourceSlice, out *v1.ResourceSlice, s conversion.Scope) error
 - func Convert_api_UniqueString_To_string(in *UniqueString, out *string, s conversion.Scope) error
 - func Convert_string_To_api_UniqueString(in *string, out *UniqueString, s conversion.Scope) error
 - func Convert_v1_CapacityRequestPolicyRange_To_api_CapacityRequestPolicyRange(in *v1.CapacityRequestPolicyRange, out *CapacityRequestPolicyRange, ...) error
 - func Convert_v1_CapacityRequestPolicy_To_api_CapacityRequestPolicy(in *v1.CapacityRequestPolicy, out *CapacityRequestPolicy, s conversion.Scope) error
 - func Convert_v1_CounterSet_To_api_CounterSet(in *v1.CounterSet, out *CounterSet, s conversion.Scope) error
 - func Convert_v1_Counter_To_api_Counter(in *v1.Counter, out *Counter, s conversion.Scope) error
 - func Convert_v1_DeviceAttribute_To_api_DeviceAttribute(in *v1.DeviceAttribute, out *DeviceAttribute, s conversion.Scope) error
 - func Convert_v1_DeviceCapacity_To_api_DeviceCapacity(in *v1.DeviceCapacity, out *DeviceCapacity, s conversion.Scope) error
 - func Convert_v1_DeviceCounterConsumption_To_api_DeviceCounterConsumption(in *v1.DeviceCounterConsumption, out *DeviceCounterConsumption, ...) error
 - func Convert_v1_DeviceTaint_To_api_DeviceTaint(in *v1.DeviceTaint, out *DeviceTaint, s conversion.Scope) error
 - func Convert_v1_Device_To_api_Device(in *v1.Device, out *Device, s conversion.Scope) error
 - func Convert_v1_ResourcePool_To_api_ResourcePool(in *v1.ResourcePool, out *ResourcePool, s conversion.Scope) error
 - func Convert_v1_ResourceSliceSpec_To_api_ResourceSliceSpec(in *v1.ResourceSliceSpec, out *ResourceSliceSpec, s conversion.Scope) error
 - func Convert_v1_ResourceSlice_To_api_ResourceSlice(in *v1.ResourceSlice, out *ResourceSlice, s conversion.Scope) error
 - func RegisterConversions(s *runtime.Scheme) error
 - type CapacityRequestPolicy
 - type CapacityRequestPolicyRange
 - type Counter
 - type CounterSet
 - type Device
 - type DeviceAttribute
 - type DeviceCapacity
 - type DeviceCounterConsumption
 - type DeviceTaint
 - type DeviceTaintEffect
 - type FullyQualifiedName
 - type QualifiedName
 - type ResourcePool
 - type ResourceSlice
 - type ResourceSliceSpec
 - type UniqueString
 
Constants ¶
This section is empty.
Variables ¶
var (
	AddToScheme = localSchemeBuilder.AddToScheme
)
    Functions ¶
func Convert_api_CapacityRequestPolicyRange_To_v1_CapacityRequestPolicyRange ¶ added in v0.34.0
func Convert_api_CapacityRequestPolicyRange_To_v1_CapacityRequestPolicyRange(in *CapacityRequestPolicyRange, out *v1.CapacityRequestPolicyRange, s conversion.Scope) error
Convert_api_CapacityRequestPolicyRange_To_v1_CapacityRequestPolicyRange is an autogenerated conversion function.
func Convert_api_CapacityRequestPolicy_To_v1_CapacityRequestPolicy ¶ added in v0.34.0
func Convert_api_CapacityRequestPolicy_To_v1_CapacityRequestPolicy(in *CapacityRequestPolicy, out *v1.CapacityRequestPolicy, s conversion.Scope) error
Convert_api_CapacityRequestPolicy_To_v1_CapacityRequestPolicy is an autogenerated conversion function.
func Convert_api_CounterSet_To_v1_CounterSet ¶ added in v0.34.0
func Convert_api_CounterSet_To_v1_CounterSet(in *CounterSet, out *v1.CounterSet, s conversion.Scope) error
Convert_api_CounterSet_To_v1_CounterSet is an autogenerated conversion function.
func Convert_api_Counter_To_v1_Counter ¶ added in v0.34.0
Convert_api_Counter_To_v1_Counter is an autogenerated conversion function.
func Convert_api_DeviceAttribute_To_v1_DeviceAttribute ¶ added in v0.34.0
func Convert_api_DeviceAttribute_To_v1_DeviceAttribute(in *DeviceAttribute, out *v1.DeviceAttribute, s conversion.Scope) error
Convert_api_DeviceAttribute_To_v1_DeviceAttribute is an autogenerated conversion function.
func Convert_api_DeviceCapacity_To_v1_DeviceCapacity ¶ added in v0.34.0
func Convert_api_DeviceCapacity_To_v1_DeviceCapacity(in *DeviceCapacity, out *v1.DeviceCapacity, s conversion.Scope) error
Convert_api_DeviceCapacity_To_v1_DeviceCapacity is an autogenerated conversion function.
func Convert_api_DeviceCounterConsumption_To_v1_DeviceCounterConsumption ¶ added in v0.34.0
func Convert_api_DeviceCounterConsumption_To_v1_DeviceCounterConsumption(in *DeviceCounterConsumption, out *v1.DeviceCounterConsumption, s conversion.Scope) error
Convert_api_DeviceCounterConsumption_To_v1_DeviceCounterConsumption is an autogenerated conversion function.
func Convert_api_DeviceTaint_To_v1_DeviceTaint ¶ added in v0.34.0
func Convert_api_DeviceTaint_To_v1_DeviceTaint(in *DeviceTaint, out *v1.DeviceTaint, s conversion.Scope) error
Convert_api_DeviceTaint_To_v1_DeviceTaint is an autogenerated conversion function.
func Convert_api_Device_To_v1_Device ¶ added in v0.34.0
Convert_api_Device_To_v1_Device is an autogenerated conversion function.
func Convert_api_ResourcePool_To_v1_ResourcePool ¶ added in v0.34.0
func Convert_api_ResourcePool_To_v1_ResourcePool(in *ResourcePool, out *v1.ResourcePool, s conversion.Scope) error
Convert_api_ResourcePool_To_v1_ResourcePool is an autogenerated conversion function.
func Convert_api_ResourceSliceSpec_To_v1_ResourceSliceSpec ¶ added in v0.34.0
func Convert_api_ResourceSliceSpec_To_v1_ResourceSliceSpec(in *ResourceSliceSpec, out *v1.ResourceSliceSpec, s conversion.Scope) error
Convert_api_ResourceSliceSpec_To_v1_ResourceSliceSpec is an autogenerated conversion function.
func Convert_api_ResourceSlice_To_v1_ResourceSlice ¶ added in v0.34.0
func Convert_api_ResourceSlice_To_v1_ResourceSlice(in *ResourceSlice, out *v1.ResourceSlice, s conversion.Scope) error
Convert_api_ResourceSlice_To_v1_ResourceSlice is an autogenerated conversion function.
func Convert_api_UniqueString_To_string ¶
func Convert_api_UniqueString_To_string(in *UniqueString, out *string, s conversion.Scope) error
func Convert_string_To_api_UniqueString ¶
func Convert_string_To_api_UniqueString(in *string, out *UniqueString, s conversion.Scope) error
func Convert_v1_CapacityRequestPolicyRange_To_api_CapacityRequestPolicyRange ¶ added in v0.34.0
func Convert_v1_CapacityRequestPolicyRange_To_api_CapacityRequestPolicyRange(in *v1.CapacityRequestPolicyRange, out *CapacityRequestPolicyRange, s conversion.Scope) error
Convert_v1_CapacityRequestPolicyRange_To_api_CapacityRequestPolicyRange is an autogenerated conversion function.
func Convert_v1_CapacityRequestPolicy_To_api_CapacityRequestPolicy ¶ added in v0.34.0
func Convert_v1_CapacityRequestPolicy_To_api_CapacityRequestPolicy(in *v1.CapacityRequestPolicy, out *CapacityRequestPolicy, s conversion.Scope) error
Convert_v1_CapacityRequestPolicy_To_api_CapacityRequestPolicy is an autogenerated conversion function.
func Convert_v1_CounterSet_To_api_CounterSet ¶ added in v0.34.0
func Convert_v1_CounterSet_To_api_CounterSet(in *v1.CounterSet, out *CounterSet, s conversion.Scope) error
Convert_v1_CounterSet_To_api_CounterSet is an autogenerated conversion function.
func Convert_v1_Counter_To_api_Counter ¶ added in v0.34.0
Convert_v1_Counter_To_api_Counter is an autogenerated conversion function.
func Convert_v1_DeviceAttribute_To_api_DeviceAttribute ¶ added in v0.34.0
func Convert_v1_DeviceAttribute_To_api_DeviceAttribute(in *v1.DeviceAttribute, out *DeviceAttribute, s conversion.Scope) error
Convert_v1_DeviceAttribute_To_api_DeviceAttribute is an autogenerated conversion function.
func Convert_v1_DeviceCapacity_To_api_DeviceCapacity ¶ added in v0.34.0
func Convert_v1_DeviceCapacity_To_api_DeviceCapacity(in *v1.DeviceCapacity, out *DeviceCapacity, s conversion.Scope) error
Convert_v1_DeviceCapacity_To_api_DeviceCapacity is an autogenerated conversion function.
func Convert_v1_DeviceCounterConsumption_To_api_DeviceCounterConsumption ¶ added in v0.34.0
func Convert_v1_DeviceCounterConsumption_To_api_DeviceCounterConsumption(in *v1.DeviceCounterConsumption, out *DeviceCounterConsumption, s conversion.Scope) error
Convert_v1_DeviceCounterConsumption_To_api_DeviceCounterConsumption is an autogenerated conversion function.
func Convert_v1_DeviceTaint_To_api_DeviceTaint ¶ added in v0.34.0
func Convert_v1_DeviceTaint_To_api_DeviceTaint(in *v1.DeviceTaint, out *DeviceTaint, s conversion.Scope) error
Convert_v1_DeviceTaint_To_api_DeviceTaint is an autogenerated conversion function.
func Convert_v1_Device_To_api_Device ¶ added in v0.34.0
Convert_v1_Device_To_api_Device is an autogenerated conversion function.
func Convert_v1_ResourcePool_To_api_ResourcePool ¶ added in v0.34.0
func Convert_v1_ResourcePool_To_api_ResourcePool(in *v1.ResourcePool, out *ResourcePool, s conversion.Scope) error
Convert_v1_ResourcePool_To_api_ResourcePool is an autogenerated conversion function.
func Convert_v1_ResourceSliceSpec_To_api_ResourceSliceSpec ¶ added in v0.34.0
func Convert_v1_ResourceSliceSpec_To_api_ResourceSliceSpec(in *v1.ResourceSliceSpec, out *ResourceSliceSpec, s conversion.Scope) error
Convert_v1_ResourceSliceSpec_To_api_ResourceSliceSpec is an autogenerated conversion function.
func Convert_v1_ResourceSlice_To_api_ResourceSlice ¶ added in v0.34.0
func Convert_v1_ResourceSlice_To_api_ResourceSlice(in *v1.ResourceSlice, out *ResourceSlice, s conversion.Scope) error
Convert_v1_ResourceSlice_To_api_ResourceSlice is an autogenerated conversion function.
func RegisterConversions ¶
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
Types ¶
type CapacityRequestPolicy ¶ added in v0.34.0
type CapacityRequestPolicy struct {
	Default     *resource.Quantity
	ValidValues []resource.Quantity
	ValidRange  *CapacityRequestPolicyRange
}
    type CapacityRequestPolicyRange ¶ added in v0.34.0
type CounterSet ¶ added in v0.33.0
type CounterSet struct {
	Name     UniqueString
	Counters map[string]Counter
}
    type Device ¶
type Device struct {
	Name                     UniqueString
	Attributes               map[QualifiedName]DeviceAttribute
	Capacity                 map[QualifiedName]DeviceCapacity
	ConsumesCounters         []DeviceCounterConsumption
	NodeName                 *string
	NodeSelector             *v1.NodeSelector
	AllNodes                 *bool
	Taints                   []resourceapi.DeviceTaint
	BindsToNode              bool
	BindingConditions        []string
	BindingFailureConditions []string
	AllowMultipleAllocations *bool
}
    type DeviceAttribute ¶
type DeviceCapacity ¶
type DeviceCapacity struct {
	Value         resource.Quantity
	RequestPolicy *CapacityRequestPolicy
}
    type DeviceCounterConsumption ¶ added in v0.33.0
type DeviceCounterConsumption struct {
	CounterSet UniqueString
	Counters   map[string]Counter
}
    type DeviceTaint ¶ added in v0.33.0
type DeviceTaint struct {
	Key       string
	Value     string
	Effect    DeviceTaintEffect
	TimeAdded *metav1.Time
}
    type DeviceTaintEffect ¶ added in v0.33.0
type DeviceTaintEffect string
const ( DeviceTaintEffectNoSchedule DeviceTaintEffect = "NoSchedule" DeviceTaintEffectNoExecute DeviceTaintEffect = "NoExecute" )
type FullyQualifiedName ¶
type FullyQualifiedName string
type QualifiedName ¶
type QualifiedName string
type ResourcePool ¶
type ResourcePool struct {
	Name               UniqueString
	Generation         int64
	ResourceSliceCount int64
}
    type ResourceSlice ¶
type ResourceSlice struct {
	metav1.TypeMeta
	metav1.ObjectMeta
	Spec ResourceSliceSpec
}
    type ResourceSliceSpec ¶
type ResourceSliceSpec struct {
	Driver                 UniqueString
	Pool                   ResourcePool
	NodeName               *string
	NodeSelector           *v1.NodeSelector
	AllNodes               bool
	Devices                []Device
	PerDeviceNodeSelection *bool
}
    type UniqueString ¶
UniqueString is a wrapper around [unique.Handle[string]].
var NullUniqueString UniqueString
    NullUniqueString is a UniqueString which contains no string.
func MakeUniqueString ¶
func MakeUniqueString(str string) UniqueString
MakeUniqueString constructs a new unique string.
func (UniqueString) String ¶
func (us UniqueString) String() string
Returns the string that is stored in the UniqueString. If the UniqueString is null, the empty string is returned.
      
      Source Files
      ¶
    
  
      
      Directories
      ¶
    
    | Path | Synopsis | 
|---|---|
| 
       Package v1beta1 provides conversion code between the v1beta1 version of the resource API and the latest API version. 
         | 
      Package v1beta1 provides conversion code between the v1beta1 version of the resource API and the latest API version. | 
| 
       Package v1beta2 provides conversion code between the v1beta2 version of the resource API and the latest API version. 
         | 
      Package v1beta2 provides conversion code between the v1beta2 version of the resource API and the latest API version. |