id

Documentation

Overview

Package id holds interfaces which objects must satisfy in order to be uniquely identifiable.

Index

• func PrintTreeNode(n TreeNode) string
• type DisallowedField
• type Path
• type TreeNode

Functions

func PrintTreeNode

func PrintTreeNode(n TreeNode) string

PrintTreeNode returns a convenient representation of a TreeNode for error messages.

Types

type DisallowedField

type DisallowedField string

DisallowedField is the json path of a field that is not allowed in imported objects.

const (
	// OwnerReference represents the ownerReference field in a metav1.Object.
	OwnerReference DisallowedField = "metadata.ownerReference"
	// SelfLink represents the selfLink field in a metav1.Object.
	SelfLink DisallowedField = "metadata.selfLink"
	// UID represents the uid field in a metav1.Object.
	UID DisallowedField = "metadata.uid"
	// ResourceVersion represents the resourceVersion field in a metav1.Object.
	ResourceVersion DisallowedField = "metadata.resourceVersion"
	// Generation represents the generation field in a metav1.Object.
	Generation DisallowedField = "metadata.generation"
	// CreationTimestamp represents the creationTimestamp field in a metav1.Object.
	CreationTimestamp DisallowedField = "metadata.creationTimestamp"
	// DeletionTimestamp represents the deletionTimestamp field in a metav1.Object.
	DeletionTimestamp DisallowedField = "metadata.deletionTimestamp"
	// DeletionGracePeriodSeconds represents the deletionGracePeriodSeconds field in a metav1.Object.
	DeletionGracePeriodSeconds DisallowedField = "metadata.deletionGracePeriodSeconds"
	// Status represents the status field in a client.Object.
	Status DisallowedField = "status"
)

type Path

type Path interface {
	// SlashPath returns the slash-delimited path.
	SlashPath() string

	// OSPath returns the OS-specific path.
	OSPath() string
}

Path represents an object associated with a path in a Nomos repository.

type TreeNode

type TreeNode interface {
	// Path is the embedded interface providing path information to this node.
	Path
	// Name returns the name of this node.
	Name() string
}

TreeNode represents a named node in the config hierarchy.