api

package

v0.35.0-beta.0 Latest Latest Go to latest Published: Nov 19, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

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_CounterSet_To_v1_CounterSet(in *CounterSet, out *v1.CounterSet, s conversion.Scope) error
func Convert_api_DeviceCounterConsumption_To_v1_DeviceCounterConsumption(in *DeviceCounterConsumption, out *v1.DeviceCounterConsumption, ...) 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_CounterSet_To_api_CounterSet(in *v1.CounterSet, out *CounterSet, s conversion.Scope) error
func Convert_v1_DeviceCounterConsumption_To_api_DeviceCounterConsumption(in *v1.DeviceCounterConsumption, out *DeviceCounterConsumption, ...) 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 CounterSet
type Device
type DeviceCounterConsumption
type ResourcePool
type ResourceSlice
type ResourceSliceSpec
type UniqueString
- func MakeUniqueString(str string) UniqueString
- func (us UniqueString) MarshalJSON() ([]byte, error)
- func (us UniqueString) MarshalText() ([]byte, error)
- func (us UniqueString) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	AddToScheme = localSchemeBuilder.AddToScheme
)

Functions ¶

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_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_Device_To_v1_Device ¶ added in v0.34.0

func Convert_api_Device_To_v1_Device(in *Device, out *v1.Device, s conversion.Scope) error

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_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_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_Device_To_api_Device ¶ added in v0.34.0

func Convert_v1_Device_To_api_Device(in *v1.Device, out *Device, s conversion.Scope) error

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 ¶

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

Types ¶

type CounterSet ¶ added in v0.33.0

type CounterSet struct {
	Name     UniqueString
	Counters map[string]resourceapi.Counter `json:",omitempty"`
}

type Device ¶

type Device struct {
	Name                     UniqueString
	Attributes               map[resourceapi.QualifiedName]resourceapi.DeviceAttribute `json:",omitempty"`
	Capacity                 map[resourceapi.QualifiedName]resourceapi.DeviceCapacity  `json:",omitempty"`
	ConsumesCounters         []DeviceCounterConsumption                                `json:",omitempty"`
	NodeName                 *string                                                   `json:",omitempty"`
	NodeSelector             *v1.NodeSelector                                          `json:",omitempty"`
	AllNodes                 *bool                                                     `json:",omitempty"`
	Taints                   []resourceapi.DeviceTaint                                 `json:",omitempty"`
	BindsToNode              bool                                                      `json:",omitempty"`
	BindingConditions        []string                                                  `json:",omitempty"`
	BindingFailureConditions []string                                                  `json:",omitempty"`
	AllowMultipleAllocations *bool                                                     `json:",omitempty"`
}

type DeviceCounterConsumption ¶ added in v0.33.0

type DeviceCounterConsumption struct {
	CounterSet UniqueString
	Counters   map[string]resourceapi.Counter `json:",omitempty"`
}

type ResourcePool ¶

type ResourcePool struct {
	Name               UniqueString
	Generation         int64
	ResourceSliceCount int64
}

type ResourceSlice ¶

type ResourceSlice struct {
	metav1.TypeMeta `json:"-"` // Not needed, not set consistently.
	metav1.ObjectMeta

	Spec ResourceSliceSpec
}

type ResourceSliceSpec ¶

type ResourceSliceSpec struct {
	Driver                 UniqueString
	Pool                   ResourcePool
	NodeName               *string          `json:",omitempty"`
	NodeSelector           *v1.NodeSelector `json:",omitempty"`
	AllNodes               bool             `json:",omitempty"`
	Devices                []Device         `json:",omitempty"`
	PerDeviceNodeSelection *bool            `json:",omitempty"`
	SharedCounters         []CounterSet     `json:",omitempty"`
}

type UniqueString ¶

type UniqueString unique.Handle[string]

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) MarshalJSON ¶

func (us UniqueString) MarshalJSON() ([]byte, error)

MarshalJSON is primarily useful for pretty-printing as JSON or YAML.

func (UniqueString) MarshalText ¶

func (us UniqueString) MarshalText() ([]byte, error)

MarshalText allows UniqueString to be used as the key in maps without causing problems for logging.

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 ¶

View all Source files

Directories ¶

Path	Synopsis
v1beta1 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.
v1beta2 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.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL