urnx

Documentation

Overview

Package urnx is a package for creating and parsing Infratographer based URNs in the format of urn:<namespace>:<resource type>:<resource id> which are used to identify resources in the Infratographer ecosystem.

Index

• Variables
• type URN
  • func Build(namespace string, resourceType string, resourceID uuid.UUID) (*URN, error)
  • func Parse(urn string) (*URN, error)
  • func (u *URN) String() string

Variables

var ErrInvalidURN = errors.New("invalid urn: expected 'urn:<namespace>:<resource type>:<resource id>")

ErrInvalidURN is returned when the URN is invalid

var ErrInvalidURNNamespace = errors.New("invalid urn namespace: expected string consisting of [A-za-z0-9-]{1,30}")

ErrInvalidURNNamespace is returned when the URN namespace is invalid and does not match the regex [A-za-z0-9-]{1,30}

var ErrInvalidURNPrefix = errors.New("invalid urn prefix: expected '" + prefix + "'")

ErrInvalidURNPrefix is returned when the URN prefix is invalid

var ErrInvalidURNResourceID = errors.New("invalid urn resource id: expected valid uuid")

ErrInvalidURNResourceID is returned when the URN resource ID is invalid and not a valid UUID

var ErrInvalidURNResourceType = errors.New("invalid urn resource type: expected string consisting of [A-za-z0-9-]{1,255}")

ErrInvalidURNResourceType is returned when the URN resource type is invalid and does not match the regex [A-za-z0-9-]{1,}

Types

type URN

type URN struct {
	Namespace    string
	ResourceType string
	ResourceID   uuid.UUID
}

URN is an infratographer based URN consisting of a namespace, resource type and resource ID

func Build

func Build(namespace string, resourceType string, resourceID uuid.UUID) (*URN, error)

Build create a new URN with the specified fields

func Parse

func Parse(urn string) (*URN, error)

Parse parses a string into a URN object

func (*URN) String

func (u *URN) String() string

String returns the string representation of the URN