Documentation
¶
Overview ¶
Package exampleocpath is a generated package which contains definitions of structs which generate gNMI paths for a YANG schema. The generated paths are based on a compressed form of the schema.
This package was generated by ygnmi version: (devel): (ygot: v0.25.4) using the following YANG input files:
- ../pathgen/testdata/yang/openconfig-simple.yang
- ../pathgen/testdata/yang/openconfig-withlistval.yang
- ../pathgen/testdata/yang/openconfig-nested.yang
Imported modules were sourced from:
Index ¶
- type Batch
- type RootPath
- func (n *RootPath) A() *nested.APath
- func (n *RootPath) Config() ygnmi.ConfigQuery[*oc.Root]
- func (n *RootPath) Model() *withlistval.ModelPath
- func (n *RootPath) Parent() *simple.ParentPath
- func (n *RootPath) RemoteContainer() *simple.RemoteContainerPath
- func (n *RootPath) State() ygnmi.SingletonQuery[*oc.Root]
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Batch ¶
type Batch struct {
// contains filtered or unexported fields
}
Batch contains a collection of paths. Calling State() or Config() on the batch returns a query that can use to Lookup, Watch, etc on multiple paths at once.
func (*Batch) AddPaths ¶
func (b *Batch) AddPaths(paths ...ygnmi.PathStruct) *Batch
AddPaths adds the paths to the batch.
type RootPath ¶
type RootPath struct {
*ygnmi.DeviceRootBase
}
RootPath represents the /root YANG schema element.
func Root ¶
func Root() *RootPath
Root returns a root path object from which YANG paths can be constructed.
func (*RootPath) A ¶
A (container):
Defining module: "openconfig-nested" Instantiating module: "openconfig-nested" Path from parent: "a" Path from root: "/a"
func (*RootPath) Config ¶
func (n *RootPath) Config() ygnmi.ConfigQuery[*oc.Root]
Config returns a Query that can be used in gNMI operations.
func (*RootPath) Model ¶
func (n *RootPath) Model() *withlistval.ModelPath
Model (container):
Defining module: "openconfig-withlistval" Instantiating module: "openconfig-withlistval" Path from parent: "model" Path from root: "/model"
func (*RootPath) Parent ¶
func (n *RootPath) Parent() *simple.ParentPath
Parent (container): I am a parent container that has 4 children.
Defining module: "openconfig-simple" Instantiating module: "openconfig-simple" Path from parent: "parent" Path from root: "/parent"
func (*RootPath) RemoteContainer ¶
func (n *RootPath) RemoteContainer() *simple.RemoteContainerPath
RemoteContainer (container):
Defining module: "openconfig-remote" Instantiating module: "openconfig-simple" Path from parent: "remote-container" Path from root: "/remote-container"
Source Files