ric_1_0_0

package
v0.0.0-...-747863f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 18, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Code generated by YGOT. DO NOT EDIT.

Package ric_1_0_0 is a generated package which contains definitions of structs which represent a YANG schema. The generated schema can be compressed by a series of transformations (compression was false in this case).

This package was generated by /Users/adibrastegarnia/go/pkg/mod/github.com/openconfig/ygot@v0.8.12/genutil/names.go using the following YANG input files:

  • xapp@2020-11-24.yang
  • kpimon-xapp@2020-12-04.yang

Imported modules were sourced from:

  • yang/...

Index

Constants

This section is empty.

Variables

View Source
var (
	SchemaTree map[string]*yang.Entry
)
View Source
var ΛEnumTypes = map[string][]reflect.Type{}

ΛEnumTypes is a map, keyed by a YANG schema path, of the enumerated types that correspond with the leaf. The type is represented as a reflect.Type. The naming of the map ensures that there are no clashes with valid YANG identifiers.

Functions

func Schema

func Schema() (*ytypes.Schema, error)

Schema returns the details of the generated schema.

func Unmarshal

func Unmarshal(data []byte, destStruct ygot.GoStruct, opts ...ytypes.UnmarshalOpt) error

Unmarshal unmarshals data, which must be RFC7951 JSON format, into destStruct, which must be non-nil and the correct GoStruct type. It returns an error if the destStruct is not found in the schema or the data cannot be unmarshaled. The supplied options (opts) are used to control the behaviour of the unmarshal function - for example, determining whether errors are thrown for unknown fields in the input JSON.

func UnzipSchema

func UnzipSchema() (map[string]*yang.Entry, error)

UnzipSchema unzips the zipped schema and returns a map of yang.Entry nodes, keyed by the name of the struct that the yang.Entry describes the schema for.

Types

type Binary

type Binary []byte

Binary is a type that is used for fields that have a YANG type of binary. It is used such that binary fields can be distinguished from leaf-lists of uint8s (which are mapped to []uint8, equivalent to []byte in reflection).

type Device

type Device struct {
	Nodes        *Xapp_Nodes              `path:"nodes" module:"xapp"`
	ReportPeriod *KpimonXapp_ReportPeriod `path:"report_period" module:"kpimon-xapp"`
}

Device represents the /device YANG schema element.

func (*Device) IsYANGGoStruct

func (*Device) IsYANGGoStruct()

IsYANGGoStruct ensures that Device implements the yang.GoStruct interface. This allows functions that need to handle this struct to identify it as being generated by ygen.

func (*Device) Validate

func (t *Device) Validate(opts ...ygot.ValidationOption) error

Validate validates s against the YANG schema corresponding to its type.

func (*Device) ΛEnumTypeMap

func (t *Device) ΛEnumTypeMap() map[string][]reflect.Type

ΛEnumTypeMap returns a map, keyed by YANG schema path, of the enumerated types that are included in the generated code.

type KpimonXapp_ReportPeriod

type KpimonXapp_ReportPeriod struct {
	Interval *uint32 `path:"interval" module:"kpimon-xapp"`
}

KpimonXapp_ReportPeriod represents the /kpimon-xapp/report_period YANG schema element.

func (*KpimonXapp_ReportPeriod) IsYANGGoStruct

func (*KpimonXapp_ReportPeriod) IsYANGGoStruct()

IsYANGGoStruct ensures that KpimonXapp_ReportPeriod implements the yang.GoStruct interface. This allows functions that need to handle this struct to identify it as being generated by ygen.

func (*KpimonXapp_ReportPeriod) Validate

func (t *KpimonXapp_ReportPeriod) Validate(opts ...ygot.ValidationOption) error

Validate validates s against the YANG schema corresponding to its type.

func (*KpimonXapp_ReportPeriod) ΛEnumTypeMap

func (t *KpimonXapp_ReportPeriod) ΛEnumTypeMap() map[string][]reflect.Type

ΛEnumTypeMap returns a map, keyed by YANG schema path, of the enumerated types that are included in the generated code.

type Xapp_Nodes

type Xapp_Nodes struct {
	Node map[string]*Xapp_Nodes_Node `path:"node" module:"xapp"`
}

Xapp_Nodes represents the /xapp/nodes YANG schema element.

func (*Xapp_Nodes) IsYANGGoStruct

func (*Xapp_Nodes) IsYANGGoStruct()

IsYANGGoStruct ensures that Xapp_Nodes implements the yang.GoStruct interface. This allows functions that need to handle this struct to identify it as being generated by ygen.

func (*Xapp_Nodes) NewNode

func (t *Xapp_Nodes) NewNode(Id string) (*Xapp_Nodes_Node, error)

NewNode creates a new entry in the Node list of the Xapp_Nodes struct. The keys of the list are populated from the input arguments.

func (*Xapp_Nodes) Validate

func (t *Xapp_Nodes) Validate(opts ...ygot.ValidationOption) error

Validate validates s against the YANG schema corresponding to its type.

func (*Xapp_Nodes) ΛEnumTypeMap

func (t *Xapp_Nodes) ΛEnumTypeMap() map[string][]reflect.Type

ΛEnumTypeMap returns a map, keyed by YANG schema path, of the enumerated types that are included in the generated code.

type Xapp_Nodes_Node

type Xapp_Nodes_Node struct {
	Id     *string `path:"id" module:"xapp"`
	Ip     *string `path:"ip" module:"xapp"`
	PlmnId *string `path:"plmn-id" module:"xapp"`
	Port   *uint16 `path:"port" module:"xapp"`
}

Xapp_Nodes_Node represents the /xapp/nodes/node YANG schema element.

func (*Xapp_Nodes_Node) IsYANGGoStruct

func (*Xapp_Nodes_Node) IsYANGGoStruct()

IsYANGGoStruct ensures that Xapp_Nodes_Node implements the yang.GoStruct interface. This allows functions that need to handle this struct to identify it as being generated by ygen.

func (*Xapp_Nodes_Node) Validate

func (t *Xapp_Nodes_Node) Validate(opts ...ygot.ValidationOption) error

Validate validates s against the YANG schema corresponding to its type.

func (*Xapp_Nodes_Node) ΛEnumTypeMap

func (t *Xapp_Nodes_Node) ΛEnumTypeMap() map[string][]reflect.Type

ΛEnumTypeMap returns a map, keyed by YANG schema path, of the enumerated types that are included in the generated code.

func (*Xapp_Nodes_Node) ΛListKeyMap

func (t *Xapp_Nodes_Node) ΛListKeyMap() (map[string]interface{}, error)

ΛListKeyMap returns the keys of the Xapp_Nodes_Node struct, which is a YANG list entry.

type YANGEmpty

type YANGEmpty bool

YANGEmpty is a type that is used for fields that have a YANG type of empty. It is used such that empty fields can be distinguished from boolean fields in the generated code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL