resid

Documentation

Index

• Constants
• type ResId
  • func FromString(s string) ResId
  • func NewResId(k gvk.Gvk, n string) ResId
  • func NewResIdKindOnly(k string, n string) ResId
  • func NewResIdWithNamespace(k gvk.Gvk, n, ns string) ResId
  • func (id ResId) EffectiveNamespace() string
  • func (id ResId) Equals(o ResId) bool
  • func (id ResId) GvknEquals(o ResId) bool
  • func (id ResId) GvknString() string
  • func (id ResId) IsInDefaultNs() bool
  • func (id ResId) IsNsEquals(o ResId) bool
  • func (id ResId) String() string

Constants

const (
	TotallyNotANamespace = "_non_namespaceable_"
	DefaultNamespace     = "default"
)

Types

type ResId

type ResId struct {
	// Gvk of the resource.
	gvk.Gvk `json:",inline,omitempty" yaml:",inline,omitempty"`

	// Name of the resource before transformation.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// Namespace the resource belongs to.
	// An untransformed resource has no namespace.
	// A fully transformed resource has the namespace
	// from the top most overlay.
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
}

ResId is an identifier of a k8s resource object.

func FromString

func FromString(s string) ResId

func NewResId

func NewResId(k gvk.Gvk, n string) ResId

NewResId creates new ResId.

func NewResIdKindOnly

func NewResIdKindOnly(k string, n string) ResId

NewResIdKindOnly creates a new ResId.

func NewResIdWithNamespace

func NewResIdWithNamespace(k gvk.Gvk, n, ns string) ResId

NewResIdWithNamespace creates new ResId in a given namespace.

func (ResId) EffectiveNamespace

func (id ResId) EffectiveNamespace() string

EffectiveNamespace returns a non-ambiguous, non-empty namespace for use in reporting and equality tests.

func (ResId) Equals

func (id ResId) Equals(o ResId) bool

Equals returns true if the other id matches namespace/Group/Version/Kind/name.

func (ResId) GvknEquals

func (id ResId) GvknEquals(o ResId) bool

GvknEquals returns true if the other id matches Group/Version/Kind/name.

func (ResId) GvknString

func (id ResId) GvknString() string

GvknString of ResId based on GVK and name

func (ResId) IsInDefaultNs

func (id ResId) IsInDefaultNs() bool

IsInDefaultNs returns true if id is a namespaceable ResId and the Namespace is either not set or set to DefaultNamespace.

func (ResId) IsNsEquals

func (id ResId) IsNsEquals(o ResId) bool

IsNsEquals returns true if the id is in the same effective namespace.

func (ResId) String

func (id ResId) String() string

String of ResId based on GVK, name and prefix