plproxy_1_0_0

Documentation

Overview

Code generated by YGOT. DO NOT EDIT.

Package plproxy_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 /root/go/pkg/mod/github.com/openconfig/ygot@v0.11.2/genutil/names.go using the following YANG input files:

• prom-label-proxy.yang

Imported modules were sourced from:

• ../../../roc-helm-charts/config-models/plproxy-1.x/files/yang/...

Index

• Variables
• func Schema() (*ytypes.Schema, error)
• func Unmarshal(data []byte, destStruct ygot.GoStruct, opts ...ytypes.UnmarshalOpt) error
• func UnzipSchema() (map[string]*yang.Entry, error)
• type Binary
• type Device
  • func (*Device) IsYANGGoStruct()
  • func (t *Device) Validate(opts ...ygot.ValidationOption) error
  • func (t *Device) ΛEnumTypeMap() map[string][]reflect.Type
• type PromLabelProxy_UserGroups
  • func (*PromLabelProxy_UserGroups) IsYANGGoStruct()
  • func (t *PromLabelProxy_UserGroups) NewUserGroup(Name string) (*PromLabelProxy_UserGroups_UserGroup, error)
  • func (t *PromLabelProxy_UserGroups) Validate(opts ...ygot.ValidationOption) error
  • func (t *PromLabelProxy_UserGroups) ΛEnumTypeMap() map[string][]reflect.Type
• type PromLabelProxy_UserGroups_UserGroup
  • func (*PromLabelProxy_UserGroups_UserGroup) IsYANGGoStruct()
  • func (t *PromLabelProxy_UserGroups_UserGroup) NewLabel(Name string) (*PromLabelProxy_UserGroups_UserGroup_Label, error)
  • func (t *PromLabelProxy_UserGroups_UserGroup) Validate(opts ...ygot.ValidationOption) error
  • func (t *PromLabelProxy_UserGroups_UserGroup) ΛEnumTypeMap() map[string][]reflect.Type
  • func (t *PromLabelProxy_UserGroups_UserGroup) ΛListKeyMap() (map[string]interface{}, error)
• type PromLabelProxy_UserGroups_UserGroup_Label
  • func (*PromLabelProxy_UserGroups_UserGroup_Label) IsYANGGoStruct()
  • func (t *PromLabelProxy_UserGroups_UserGroup_Label) Validate(opts ...ygot.ValidationOption) error
  • func (t *PromLabelProxy_UserGroups_UserGroup_Label) ΛEnumTypeMap() map[string][]reflect.Type
  • func (t *PromLabelProxy_UserGroups_UserGroup_Label) ΛListKeyMap() (map[string]interface{}, error)
• type YANGEmpty

Variables

var (
	SchemaTree map[string]*yang.Entry
)

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 {
	UserGroups *PromLabelProxy_UserGroups `path:"user-groups" module:"prom-label-proxy"`
}

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 PromLabelProxy_UserGroups

type PromLabelProxy_UserGroups struct {
	UserGroup map[string]*PromLabelProxy_UserGroups_UserGroup `path:"user-group" module:"prom-label-proxy"`
}

PromLabelProxy_UserGroups represents the /prom-label-proxy/user-groups YANG schema element.

func (*PromLabelProxy_UserGroups) IsYANGGoStruct

func (*PromLabelProxy_UserGroups) IsYANGGoStruct()

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

func (*PromLabelProxy_UserGroups) NewUserGroup

func (t *PromLabelProxy_UserGroups) NewUserGroup(Name string) (*PromLabelProxy_UserGroups_UserGroup, error)

NewUserGroup creates a new entry in the UserGroup list of the PromLabelProxy_UserGroups struct. The keys of the list are populated from the input arguments.

func (*PromLabelProxy_UserGroups) Validate

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

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

func (*PromLabelProxy_UserGroups) ΛEnumTypeMap

func (t *PromLabelProxy_UserGroups) Λ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 PromLabelProxy_UserGroups_UserGroup

type PromLabelProxy_UserGroups_UserGroup struct {
	Label map[string]*PromLabelProxy_UserGroups_UserGroup_Label `path:"label" module:"prom-label-proxy"`
	Name  *string                                               `path:"name" module:"prom-label-proxy"`
}

PromLabelProxy_UserGroups_UserGroup represents the /prom-label-proxy/user-groups/user-group YANG schema element.

func (*PromLabelProxy_UserGroups_UserGroup) IsYANGGoStruct

func (*PromLabelProxy_UserGroups_UserGroup) IsYANGGoStruct()

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

func (*PromLabelProxy_UserGroups_UserGroup) NewLabel

func (t *PromLabelProxy_UserGroups_UserGroup) NewLabel(Name string) (*PromLabelProxy_UserGroups_UserGroup_Label, error)

NewLabel creates a new entry in the Label list of the PromLabelProxy_UserGroups_UserGroup struct. The keys of the list are populated from the input arguments.

func (*PromLabelProxy_UserGroups_UserGroup) Validate

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

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

func (*PromLabelProxy_UserGroups_UserGroup) ΛEnumTypeMap

func (t *PromLabelProxy_UserGroups_UserGroup) Λ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 (*PromLabelProxy_UserGroups_UserGroup) ΛListKeyMap

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

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

type PromLabelProxy_UserGroups_UserGroup_Label

type PromLabelProxy_UserGroups_UserGroup_Label struct {
	Name  *string `path:"name" module:"prom-label-proxy"`
	Value *string `path:"value" module:"prom-label-proxy"`
}

PromLabelProxy_UserGroups_UserGroup_Label represents the /prom-label-proxy/user-groups/user-group/label YANG schema element.

func (*PromLabelProxy_UserGroups_UserGroup_Label) IsYANGGoStruct

func (*PromLabelProxy_UserGroups_UserGroup_Label) IsYANGGoStruct()

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

func (*PromLabelProxy_UserGroups_UserGroup_Label) Validate

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

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

func (*PromLabelProxy_UserGroups_UserGroup_Label) ΛEnumTypeMap

func (t *PromLabelProxy_UserGroups_UserGroup_Label) Λ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 (*PromLabelProxy_UserGroups_UserGroup_Label) ΛListKeyMap

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

ΛListKeyMap returns the keys of the PromLabelProxy_UserGroups_UserGroup_Label 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.