runtime

Documentation

Overview

+k8s:deepcopy-gen=package

Index

• func RegisterDefaults(scheme *runtime.Scheme) error
• type APIType
  • func APITypeFrom(obj Object) *APIType
  • func NewAPIType() *APIType
  • func (in *APIType) DeepCopy() *APIType
  • func (in *APIType) DeepCopyInto(out *APIType)
  • func (in *APIType) DeepCopyObject() pkgruntime.Object
• type APITypeList
  • func (in APITypeList) DeepCopy() APITypeList
  • func (in APITypeList) DeepCopyInto(out *APITypeList)
• type Kind
  • func ParseKind(input string) Kind
  • func (k Kind) Lower() string
  • func (k Kind) String() string
  • func (k Kind) Title() string
• type Object
• type ObjectMeta
  • func (in *ObjectMeta) DeepCopy() *ObjectMeta
  • func (in *ObjectMeta) DeepCopyInto(out *ObjectMeta)
  • func (o *ObjectMeta) GetAnnotation(key string) string
  • func (o *ObjectMeta) GetCreated() Time
  • func (o *ObjectMeta) GetLabel(key string) string
  • func (o *ObjectMeta) GetName() string
  • func (o *ObjectMeta) GetObjectMeta() *ObjectMeta
  • func (o *ObjectMeta) GetUID() UID
  • func (o *ObjectMeta) SetAnnotation(key, value string)
  • func (o *ObjectMeta) SetCreated(t Time)
  • func (o *ObjectMeta) SetLabel(key, value string)
  • func (o *ObjectMeta) SetName(name string)
  • func (o *ObjectMeta) SetUID(uid UID)
• type Time
  • func Timestamp() Time
  • func (in *Time) DeepCopy() *Time
  • func (in *Time) DeepCopyInto(out *Time)
  • func (t Time) MarshalJSON() (b []byte, err error)
  • func (t Time) String() string
• type TypeMeta
  • func (in *TypeMeta) DeepCopy() *TypeMeta
  • func (in *TypeMeta) DeepCopyInto(out *TypeMeta)
  • func (t *TypeMeta) GetKind() Kind
  • func (t *TypeMeta) GetTypeMeta() *TypeMeta
  • func (t *TypeMeta) GroupVersionKind() schema.GroupVersionKind
  • func (t *TypeMeta) SetGroupVersionKind(gvk schema.GroupVersionKind)
• type UID
  • func (u UID) String() string
  • func (u *UID) UnmarshalJSON(b []byte) error

Functions

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

Types

type APIType

type APIType struct {
	*TypeMeta   `json:",inline"`
	*ObjectMeta `json:"metadata"`
}

APIType is a struct implementing Object, used for unmarshalling unknown objects into this intermediate type where .Name, .UID, .Kind and .APIVersion become easily available +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func APITypeFrom

func APITypeFrom(obj Object) *APIType

APITypeFrom is used to create a bound APIType from an Object

func NewAPIType

func NewAPIType() *APIType

This constructor ensures the APIType fields are not nil

func (*APIType) DeepCopy

func (in *APIType) DeepCopy() *APIType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIType.

func (*APIType) DeepCopyInto

func (in *APIType) DeepCopyInto(out *APIType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIType) DeepCopyObject

func (in *APIType) DeepCopyObject() pkgruntime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new pkgruntime.Object.

type APITypeList

type APITypeList []*APIType

APITypeList is a list of many pointers APIType objects

func (APITypeList) DeepCopy

func (in APITypeList) DeepCopy() APITypeList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APITypeList.

func (APITypeList) DeepCopyInto

func (in APITypeList) DeepCopyInto(out *APITypeList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Kind

type Kind string

func ParseKind

func ParseKind(input string) Kind

Returns a Kind parsed from the given string

func (Kind) Lower

func (k Kind) Lower() string

Returns a lowercase string representation of the Kind

func (Kind) String

func (k Kind) String() string

Returns a string representation of the Kind suitable for sentences

func (Kind) Title

func (k Kind) Title() string

Returns a title case string representation of the Kind

type Object

type Object interface {
	runtime.Object

	GetTypeMeta() *TypeMeta
	GetObjectMeta() *ObjectMeta

	GetKind() Kind
	GroupVersionKind() schema.GroupVersionKind
	SetGroupVersionKind(schema.GroupVersionKind)

	GetName() string
	SetName(string)

	GetUID() UID
	SetUID(UID)

	GetCreated() Time
	SetCreated(t Time)

	GetLabel(key string) string
	SetLabel(key, value string)

	GetAnnotation(key string) string
	SetAnnotation(key, value string)
}

Object extends k8s.io/apimachinery's runtime.Object with extra GetName() and GetUID() methods from ObjectMeta

type ObjectMeta

type ObjectMeta struct {
	Name        string            `json:"name"`
	UID         UID               `json:"uid,omitempty"`
	Created     Time              `json:"created"`
	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

ObjectMeta have to be embedded into any serializable object. It provides the .GetName() and .GetUID() methods that help implement the Object interface

func (*ObjectMeta) DeepCopy

func (in *ObjectMeta) DeepCopy() *ObjectMeta

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectMeta.

func (*ObjectMeta) DeepCopyInto

func (in *ObjectMeta) DeepCopyInto(out *ObjectMeta)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ObjectMeta) GetAnnotation

func (o *ObjectMeta) GetAnnotation(key string) string

GetAnnotation returns the label value for the key

func (*ObjectMeta) GetCreated

func (o *ObjectMeta) GetCreated() Time

GetCreated returns when the Object was created

func (*ObjectMeta) GetLabel

func (o *ObjectMeta) GetLabel(key string) string

GetLabel returns the label value for the key

func (*ObjectMeta) GetName

func (o *ObjectMeta) GetName() string

GetName returns the name of the Object

func (*ObjectMeta) GetObjectMeta

func (o *ObjectMeta) GetObjectMeta() *ObjectMeta

This is a helper for APIType generation

func (*ObjectMeta) GetUID

func (o *ObjectMeta) GetUID() UID

GetUID returns the UID of the Object

func (*ObjectMeta) SetAnnotation

func (o *ObjectMeta) SetAnnotation(key, value string)

SetAnnotation sets a label value for a key

func (*ObjectMeta) SetCreated

func (o *ObjectMeta) SetCreated(t Time)

SetCreated sets the creation time of the Object

func (*ObjectMeta) SetLabel

func (o *ObjectMeta) SetLabel(key, value string)

SetLabel sets a label value for a key

func (*ObjectMeta) SetName

func (o *ObjectMeta) SetName(name string)

SetName sets the name of the Object

func (*ObjectMeta) SetUID

func (o *ObjectMeta) SetUID(uid UID)

SetUID sets the UID of the Object

type Time

type Time struct {
	metav1.Time
}

func Timestamp

func Timestamp() Time

Timestamp returns the current UTC time

func (*Time) DeepCopy

func (in *Time) DeepCopy() *Time

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Time.

func (*Time) DeepCopyInto

func (in *Time) DeepCopyInto(out *Time)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Time) MarshalJSON

func (t Time) MarshalJSON() (b []byte, err error)

func (Time) String

func (t Time) String() string

The default string for Time is a human readable difference between the Time and the current time

type TypeMeta

type TypeMeta struct {
	metav1.TypeMeta
}

TypeMeta is an alias for the k8s/apimachinery TypeMeta with some additional methods

func (*TypeMeta) DeepCopy

func (in *TypeMeta) DeepCopy() *TypeMeta

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TypeMeta.

func (*TypeMeta) DeepCopyInto

func (in *TypeMeta) DeepCopyInto(out *TypeMeta)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TypeMeta) GetKind

func (t *TypeMeta) GetKind() Kind

func (*TypeMeta) GetTypeMeta

func (t *TypeMeta) GetTypeMeta() *TypeMeta

This is a helper for APIType generation

func (*TypeMeta) GroupVersionKind

func (t *TypeMeta) GroupVersionKind() schema.GroupVersionKind

func (*TypeMeta) SetGroupVersionKind

func (t *TypeMeta) SetGroupVersionKind(gvk schema.GroupVersionKind)

type UID

type UID string

UID represents an unique ID for a type

func (UID) String

func (u UID) String() string

String returns the UID in string representation

func (*UID) UnmarshalJSON

func (u *UID) UnmarshalJSON(b []byte) error

This unmarshaler enables the UID to be passed in as an unquoted string in JSON. Upon marshaling, quotes will be automatically added.