runtime

Documentation

Overview

+k8s:deepcopy-gen=package

Index

• Constants
• type IdentifierFactory
• type Identifyable
  • func NewIdentifier(str string) Identifyable
• type Metav1NameIdentifierFactory
  • func (in *Metav1NameIdentifierFactory) DeepCopy() *Metav1NameIdentifierFactory
  • func (in *Metav1NameIdentifierFactory) DeepCopyInto(out *Metav1NameIdentifierFactory)
  • func (id Metav1NameIdentifierFactory) Identify(o interface{}) (Identifyable, bool)
• type Object
• type ObjectUIDIdentifierFactory
  • func (in *ObjectUIDIdentifierFactory) DeepCopy() *ObjectUIDIdentifierFactory
  • func (in *ObjectUIDIdentifierFactory) DeepCopyInto(out *ObjectUIDIdentifierFactory)
  • func (id ObjectUIDIdentifierFactory) Identify(o interface{}) (Identifyable, bool)
• type PartialObject
  • func NewPartialObject(frame []byte) (PartialObject, error)
• type PartialObjectImpl
  • func (in *PartialObjectImpl) DeepCopy() *PartialObjectImpl
  • func (in *PartialObjectImpl) DeepCopyInto(out *PartialObjectImpl)
  • func (in *PartialObjectImpl) DeepCopyObject() pkgruntime.Object
  • func (po *PartialObjectImpl) IsPartialObject()

Constants

const DefaultNamespace = "default"

DefaultNamespace describes the default namespace name used for the system.

Types

type IdentifierFactory

type IdentifierFactory interface {
	Identify(o interface{}) (id Identifyable, ok bool)
}

var (
	// Metav1Identifier identifies an object using its metav1.ObjectMeta Name and Namespace
	Metav1NameIdentifier IdentifierFactory = Metav1NameIdentifierFactory{}
	// ObjectUIDIdentifier identifies an object using its libgitops/pkg/runtime.ObjectMeta UID field
	ObjectUIDIdentifier IdentifierFactory = ObjectUIDIdentifierFactory{}
)

type Identifyable

type Identifyable interface {
	// GetIdentifier can return e.g. a "namespace/name" combination, which is not guaranteed
	// to be unique world-wide, or alternatively a random SHA for instance
	GetIdentifier() string
}

Identifyable is an object which can be identified

func NewIdentifier

func NewIdentifier(str string) Identifyable

type Metav1NameIdentifierFactory

type Metav1NameIdentifierFactory struct{}

func (*Metav1NameIdentifierFactory) DeepCopy

func (in *Metav1NameIdentifierFactory) DeepCopy() *Metav1NameIdentifierFactory

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

func (*Metav1NameIdentifierFactory) DeepCopyInto

func (in *Metav1NameIdentifierFactory) DeepCopyInto(out *Metav1NameIdentifierFactory)

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

func (Metav1NameIdentifierFactory) Identify

func (id Metav1NameIdentifierFactory) Identify(o interface{}) (Identifyable, bool)

type Object

type Object interface {
	runtime.Object
	metav1.ObjectMetaAccessor
	metav1.Object
}

Object is an union of the Object interfaces that are accessible for a type that embeds both metav1.TypeMeta and metav1.ObjectMeta.

type ObjectUIDIdentifierFactory

type ObjectUIDIdentifierFactory struct{}

func (*ObjectUIDIdentifierFactory) DeepCopy

func (in *ObjectUIDIdentifierFactory) DeepCopy() *ObjectUIDIdentifierFactory

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

func (*ObjectUIDIdentifierFactory) DeepCopyInto

func (in *ObjectUIDIdentifierFactory) DeepCopyInto(out *ObjectUIDIdentifierFactory)

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

func (ObjectUIDIdentifierFactory) Identify

func (id ObjectUIDIdentifierFactory) Identify(o interface{}) (Identifyable, bool)

type PartialObject

type PartialObject interface {
	Object

	// IsPartialObject is a dummy function for signalling that this is a partially-loaded object
	// i.e. only TypeMeta and ObjectMeta are stored in memory.
	IsPartialObject()
}

PartialObject is a partially-decoded object, where only metadata has been loaded.

func NewPartialObject

func NewPartialObject(frame []byte) (PartialObject, error)

This constructor ensures the PartialObjectImpl fields are not nil. TODO: Make this multi-document-aware?

type PartialObjectImpl

type PartialObjectImpl struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
}

PartialObjectImpl is a struct implementing PartialObject, 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 (*PartialObjectImpl) DeepCopy

func (in *PartialObjectImpl) DeepCopy() *PartialObjectImpl

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

func (*PartialObjectImpl) DeepCopyInto

func (in *PartialObjectImpl) DeepCopyInto(out *PartialObjectImpl)

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

func (*PartialObjectImpl) DeepCopyObject

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

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

func (*PartialObjectImpl) IsPartialObject

func (po *PartialObjectImpl) IsPartialObject()