resource

Documentation

Index

• type Option
  • func WithExclude(p string) Option
  • func WithModule(m string) Option
  • func WithXPath(p string) Option
• type Resource
  • func NewResource(parent *Resource, opts ...Option) *Resource
  • func (r *Resource) AddChild(res *Resource)
  • func (r *Resource) AddExternalLeafRef(ll, rl *gnmi.Path)
  • func (r *Resource) AddLocalLeafRef(ll, rl *gnmi.Path)
  • func (r *Resource) GetAbsoluteGnmiPathFromSource() *gnmi.Path
  • func (r *Resource) GetAbsoluteName() string
  • func (r *Resource) GetAbsolutePath() *gnmi.Path
  • func (r *Resource) GetActualGnmiFullPathWithKeys() *gnmi.Path
  • func (r *Resource) GetChildResources() []string
  • func (r *Resource) GetChildren() []*Resource
  • func (r *Resource) GetExcludeRelativeXPath() []string
  • func (r *Resource) GetExternalLeafRef() []*parser.LeafRefGnmi
  • func (r *Resource) GetLocalLeafRef() []*parser.LeafRefGnmi
  • func (r *Resource) GetModule() string
  • func (r *Resource) GetParent() *Resource
  • func (r *Resource) GetParentPath() *gnmi.Path
  • func (r *Resource) GetParentResource() string
  • func (r *Resource) GetResourceNameWithPrefix(prefix string) string
  • func (r *Resource) GetResourcePath() *gnmi.Path
  • func (r *Resource) GetRootContainerEntry() *container.Entry
  • func (r *Resource) ResourceLastElement() string
  • func (r *Resource) SetRootContainerEntry(e *container.Entry)

Types

type Option

type Option func(g *Resource)

Option can be used to manipulate Options.

func WithExclude

func WithExclude(p string) Option

func WithModule

func WithModule(m string) Option

func WithXPath

func WithXPath(p string) Option

type Resource

type Resource struct {
	Parent   *Resource   // resource parent
	Children []*Resource // the children of the resource
	Module   string      // Yang Module name of the resource
	//parser               *parser.Parser                 // calls a library for parsing JSON/YANG elements
	Path *gnmi.Path // relative path from the resource; the absolute path is assembled using the resurce hierarchy with Parent

	Excludes []*gnmi.Path // relative from the the resource
	//FileName           string                         // the filename the resource is using to render out the config
	//ResFile            *os.File                       // the file reference for writing the resource file
	RootContainerEntry *container.Entry     // this is the root element which is used to reference the hierarchical resource information
	RootContainer      *container.Container // root container of the resource
	//LastContainerPtr   *container.Container   // pointer to the last container we process
	ContainerList      []*container.Container         // List of all containers within the resource
	ContainerLevel     int                            // the current container Level when processing the yang entries using ygen
	ContainerLevelKeys map[int][]*container.Container // the current container Level key list
	LocalLeafRefs      []*parser.LeafRefGnmi
	ExternalLeafRefs   []*parser.LeafRefGnmi
}

func NewResource

func NewResource(parent *Resource, opts ...Option) *Resource

func (*Resource) AddChild

func (r *Resource) AddChild(res *Resource)

func (*Resource) AddExternalLeafRef

func (r *Resource) AddExternalLeafRef(ll, rl *gnmi.Path)

func (*Resource) AddLocalLeafRef

func (r *Resource) AddLocalLeafRef(ll, rl *gnmi.Path)

func (*Resource) GetAbsoluteGnmiPathFromSource

func (r *Resource) GetAbsoluteGnmiPathFromSource() *gnmi.Path

GetAbsoluteGnmiPathFromSource used for leafref validation in ygen

func (*Resource) GetAbsoluteName

func (r *Resource) GetAbsoluteName() string

func (*Resource) GetAbsolutePath

func (r *Resource) GetAbsolutePath() *gnmi.Path

func (*Resource) GetActualGnmiFullPathWithKeys

func (r *Resource) GetActualGnmiFullPathWithKeys() *gnmi.Path

GetActualGnmiFullPathWithKeys goes to the root and trickless back to get the full path with the keys; uses the containers to figure out the path used in ndd-builder

func (*Resource) GetChildResources

func (r *Resource) GetChildResources() []string

func (*Resource) GetChildren

func (r *Resource) GetChildren() []*Resource

func (*Resource) GetExcludeRelativeXPath

func (r *Resource) GetExcludeRelativeXPath() []string

func (*Resource) GetExternalLeafRef

func (r *Resource) GetExternalLeafRef() []*parser.LeafRefGnmi

func (*Resource) GetLocalLeafRef

func (r *Resource) GetLocalLeafRef() []*parser.LeafRefGnmi

func (*Resource) GetModule

func (r *Resource) GetModule() string

func (*Resource) GetParent

func (r *Resource) GetParent() *Resource

func (*Resource) GetParentPath

func (r *Resource) GetParentPath() *gnmi.Path

func (*Resource) GetParentResource

func (r *Resource) GetParentResource() string

func (*Resource) GetResourceNameWithPrefix

func (r *Resource) GetResourceNameWithPrefix(prefix string) string

GetResourceNameWithPrefix -> nddbuilder

func (*Resource) GetResourcePath

func (r *Resource) GetResourcePath() *gnmi.Path

func (*Resource) GetRootContainerEntry

func (r *Resource) GetRootContainerEntry() *container.Entry

func (*Resource) ResourceLastElement

func (r *Resource) ResourceLastElement() string

func (*Resource) SetRootContainerEntry

func (r *Resource) SetRootContainerEntry(e *container.Entry)