Documentation
¶
Index ¶
- Variables
- type Meta
- type Resource
- type ResourceID
- type ResourceIDSet
- func (s ResourceIDSet) Add(ids []ResourceID)
- func (s ResourceIDSet) Contains(id ResourceID) bool
- func (s ResourceIDSet) Intersection(others ResourceIDSet) ResourceIDSet
- func (s ResourceIDSet) String() string
- func (s ResourceIDSet) ToSlice() ResourceIDs
- func (s ResourceIDSet) Without(others ResourceIDSet) ResourceIDSet
- type ResourceIDs
- func (ids ResourceIDs) Contains(id ResourceID) bool
- func (ids ResourceIDs) Intersection(others ResourceIDSet) ResourceIDSet
- func (p ResourceIDs) Len() int
- func (p ResourceIDs) Less(i, j int) bool
- func (p ResourceIDs) Sort()
- func (p ResourceIDs) Swap(i, j int)
- func (ids ResourceIDs) Without(others ResourceIDSet) (res ResourceIDs)
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidServiceID = errors.New("invalid service ID") LegacyServiceIDRegexp = regexp.MustCompile("^([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)$") ResourceIDRegexp = regexp.MustCompile("^([a-zA-Z0-9_-]+):([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)$") UnqualifiedResourceIDRegexp = regexp.MustCompile("^([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)$") )
Functions ¶
This section is empty.
Types ¶
type Resource ¶
type Resource interface {
ResourceID() ResourceID // name, to correlate with what's in the cluster
Source() string // where did this come from (informational)
Bytes() []byte // the definition, for sending to cluster.Sync
Metas() Meta
SourceKind() string
}
type ResourceID ¶
type ResourceID struct {
// contains filtered or unexported fields
}
ResourceID is an opaque type which uniquely identifies a resource in an orchestrator.
func MakeResourceID ¶
func MakeResourceID(namespace, kind, name string) ResourceID
MakeResourceID constructs a ResourceID from constituent components.
func MustParseResourceID ¶
func MustParseResourceID(s string) ResourceID
MustParseResourceID constructs a ResourceID from a string representation, panicing if the format is invalid.
func ParseResourceID ¶
func ParseResourceID(s string) (ResourceID, error)
ParseResourceID constructs a ResourceID from a string representation if possible, returning an error value otherwise.
func ParseResourceIDOptionalNamespace ¶
func ParseResourceIDOptionalNamespace(namespace, s string) (ResourceID, error)
ParseResourceIDOptionalNamespace constructs a ResourceID from either a fully qualified string representation, or an unqualified kind/name representation and the supplied namespace.
func (ResourceID) Components ¶
func (id ResourceID) Components() (namespace, kind, name string)
Components returns the constituent components of a ResourceID
func (ResourceID) MarshalJSON ¶
func (id ResourceID) MarshalJSON() ([]byte, error)
MarshalJSON encodes a ResourceID as a JSON string. This is done to maintain backwards compatibility with previous flux versions where the ResourceID is a plain string.
func (ResourceID) MarshalText ¶
func (id ResourceID) MarshalText() (text []byte, err error)
MarshalText encodes a ResourceID as a flat string; this is required because ResourceIDs are sometimes used as map keys.
func (*ResourceID) UnmarshalJSON ¶
func (id *ResourceID) UnmarshalJSON(data []byte) (err error)
UnmarshalJSON decodes a ResourceID from a JSON string. This is done to maintain backwards compatibility with previous flux versions where the ResourceID is a plain string.
func (*ResourceID) UnmarshalText ¶
func (id *ResourceID) UnmarshalText(text []byte) error
MarshalText decodes a ResourceID from a flat string; this is required because ResourceIDs are sometimes used as map keys.
type ResourceIDSet ¶
type ResourceIDSet map[ResourceID]struct{}
func (ResourceIDSet) Add ¶
func (s ResourceIDSet) Add(ids []ResourceID)
func (ResourceIDSet) Contains ¶
func (s ResourceIDSet) Contains(id ResourceID) bool
func (ResourceIDSet) Intersection ¶
func (s ResourceIDSet) Intersection(others ResourceIDSet) ResourceIDSet
func (ResourceIDSet) String ¶
func (s ResourceIDSet) String() string
func (ResourceIDSet) ToSlice ¶
func (s ResourceIDSet) ToSlice() ResourceIDs
func (ResourceIDSet) Without ¶
func (s ResourceIDSet) Without(others ResourceIDSet) ResourceIDSet
type ResourceIDs ¶
type ResourceIDs []ResourceID
func (ResourceIDs) Contains ¶
func (ids ResourceIDs) Contains(id ResourceID) bool
func (ResourceIDs) Intersection ¶
func (ids ResourceIDs) Intersection(others ResourceIDSet) ResourceIDSet
func (ResourceIDs) Len ¶
func (p ResourceIDs) Len() int
func (ResourceIDs) Less ¶
func (p ResourceIDs) Less(i, j int) bool
func (ResourceIDs) Sort ¶
func (p ResourceIDs) Sort()
func (ResourceIDs) Swap ¶
func (p ResourceIDs) Swap(i, j int)
func (ResourceIDs) Without ¶
func (ids ResourceIDs) Without(others ResourceIDSet) (res ResourceIDs)
Source Files