uexampleocpath

Documentation

Overview

Package uexampleocpath is a generated package which contains definitions of structs which generate gNMI paths for a YANG schema.

This package was generated by ygnmi version: (devel): (ygot: v0.29.17) 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
  • func (b *Batch) AddPaths(paths ...ygnmi.PathStruct) *Batch
  • func (b *Batch) Query() ygnmi.SingletonQuery[*oc.Device]
• type DevicePath
  • func Root() *DevicePath
  • func (n *DevicePath) A() *nested.OpenconfigNested_APath
  • func (n *DevicePath) Container() *nested.OpenconfigNested_ContainerPath
  • func (n *DevicePath) Model() *withlistval.OpenconfigWithlistval_ModelPath
  • func (n *DevicePath) Parent() *simple.OpenconfigSimple_ParentPath
  • func (n *DevicePath) RemoteContainer() *simple.OpenconfigSimple_RemoteContainerPath

Types

type Batch

type Batch struct {
	// contains filtered or unexported fields
}

Batch contains a collection of paths. Use batch to call 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.

func (*Batch) Query

func (b *Batch) Query() ygnmi.SingletonQuery[*oc.Device]

Query returns a Query that can be used in gNMI operations. The returned query is immutable, adding paths does not modify existing queries.

type DevicePath

type DevicePath struct {
	*ygnmi.DeviceRootBase
}

DevicePath represents the /device YANG schema element.

func Root

func Root() *DevicePath

Root returns a root path object from which YANG paths can be constructed.

func (*DevicePath) A

func (n *DevicePath) A() *nested.OpenconfigNested_APath

A (container):

Defining module:      "openconfig-nested"
Instantiating module: "openconfig-nested"
Path from parent:     "a"
Path from root:       "/a"

func (*DevicePath) Container

func (n *DevicePath) Container() *nested.OpenconfigNested_ContainerPath

Container (container):

Defining module:      "openconfig-nested"
Instantiating module: "openconfig-nested"
Path from parent:     "container"
Path from root:       "/container"

func (*DevicePath) Model

func (n *DevicePath) Model() *withlistval.OpenconfigWithlistval_ModelPath

Model (container):

Defining module:      "openconfig-withlistval"
Instantiating module: "openconfig-withlistval"
Path from parent:     "model"
Path from root:       "/model"

func (*DevicePath) Parent

func (n *DevicePath) Parent() *simple.OpenconfigSimple_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 (*DevicePath) RemoteContainer

func (n *DevicePath) RemoteContainer() *simple.OpenconfigSimple_RemoteContainerPath

RemoteContainer (container):

Defining module:      "openconfig-remote"
Instantiating module: "openconfig-simple"
Path from parent:     "remote-container"
Path from root:       "/remote-container"