ocpaths

package
v0.0.0-...-e8efe0d Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	GNMIRpc_SubscribeMode_name = map[int32]string{
		0: "UNSPECIFIED_SUBSCRIBE_MODE",
		1: "NO_READ_SUPPORT",
		2: "STREAM",
		3: "ONCE",
		4: "POLL",
	}
	GNMIRpc_SubscribeMode_value = map[string]int32{
		"UNSPECIFIED_SUBSCRIBE_MODE": 0,
		"NO_READ_SUPPORT":            1,
		"STREAM":                     2,
		"ONCE":                       3,
		"POLL":                       4,
	}
)

Enum value maps for GNMIRpc_SubscribeMode.

View Source 
var (
	GNMIRpc_StreamMode_name = map[int32]string{
		0: "UNSPECIFIED_STREAM_MODE",
		1: "NO_STREAMING_SUPPORT",
		2: "TARGET_DEFINED",
		3: "ON_CHANGE",
		4: "SAMPLE",
	}
	GNMIRpc_StreamMode_value = map[string]int32{
		"UNSPECIFIED_STREAM_MODE": 0,
		"NO_STREAMING_SUPPORT":    1,
		"TARGET_DEFINED":          2,
		"ON_CHANGE":               3,
		"SAMPLE":                  4,
	}
)

Enum value maps for GNMIRpc_StreamMode.

View Source 
var File_ocpaths_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type GNMIRpc 

type GNMIRpc struct {
	Get        bool                    `protobuf:"varint,1,opt,name=get,proto3" json:"get,omitempty"`
	Set        bool                    `protobuf:"varint,2,opt,name=set,proto3" json:"set,omitempty"`
	Subscribe  bool                    `protobuf:"varint,3,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
	SubMode    []GNMIRpc_SubscribeMode `` /* 136-byte string literal not displayed */
	StreamMode []GNMIRpc_StreamMode    `` /* 142-byte string literal not displayed */
	// If listed as part of a requirement, sample_interval_nanoseconds is the
	// maximum allowable interval between updates.
	// If listed as part of the description of level of support, it should be the
	// smallest, recommended value.
	SampleIntervalNanoseconds uint64 `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

GNMIRpc describes expected (or supported) behavior for a particular Openconfig path.

func (*GNMIRpc) Descriptor deprecated 

func (*GNMIRpc) Descriptor() ([]byte, []int)

Deprecated: Use GNMIRpc.ProtoReflect.Descriptor instead.

func (*GNMIRpc) GetGet 

func (x *GNMIRpc) GetGet() bool

func (*GNMIRpc) GetSampleIntervalNanoseconds 

func (x *GNMIRpc) GetSampleIntervalNanoseconds() uint64

func (*GNMIRpc) GetSet 

func (x *GNMIRpc) GetSet() bool

func (*GNMIRpc) GetStreamMode 

func (x *GNMIRpc) GetStreamMode() []GNMIRpc_StreamMode

func (*GNMIRpc) GetSubMode 

func (x *GNMIRpc) GetSubMode() []GNMIRpc_SubscribeMode

func (*GNMIRpc) GetSubscribe 

func (x *GNMIRpc) GetSubscribe() bool

func (*GNMIRpc) ProtoMessage 

func (*GNMIRpc) ProtoMessage()

func (*GNMIRpc) ProtoReflect 

func (x *GNMIRpc) ProtoReflect() protoreflect.Message

func (*GNMIRpc) Reset 

func (x *GNMIRpc) Reset()

func (*GNMIRpc) String 

func (x *GNMIRpc) String() string

type GNMIRpc_StreamMode 

type GNMIRpc_StreamMode int32

StreamMode is the mode of a streamed subscription, specifying how the target must return values for that subscription. Reference: gNMI Specification Section 3.5.1.3 

const (
	GNMIRpc_UNSPECIFIED_STREAM_MODE GNMIRpc_StreamMode = 0
	GNMIRpc_NO_STREAMING_SUPPORT    GNMIRpc_StreamMode = 1 // No requirement / support for streaming path.
	GNMIRpc_TARGET_DEFINED          GNMIRpc_StreamMode = 2 // The target selects for each element.
	GNMIRpc_ON_CHANGE               GNMIRpc_StreamMode = 3 // The target sends an update on element value change.
	GNMIRpc_SAMPLE                  GNMIRpc_StreamMode = 4 // The target samples values according to the interval.
)

func (GNMIRpc_StreamMode) Descriptor 

func (GNMIRpc_StreamMode) Descriptor() protoreflect.EnumDescriptor

func (GNMIRpc_StreamMode) Enum 

func (x GNMIRpc_StreamMode) Enum() *GNMIRpc_StreamMode

func (GNMIRpc_StreamMode) EnumDescriptor deprecated 

func (GNMIRpc_StreamMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use GNMIRpc_StreamMode.Descriptor instead.

func (GNMIRpc_StreamMode) Number 

func (x GNMIRpc_StreamMode) Number() protoreflect.EnumNumber

func (GNMIRpc_StreamMode) String 

func (x GNMIRpc_StreamMode) String() string

func (GNMIRpc_StreamMode) Type 

func (GNMIRpc_StreamMode) Type() protoreflect.EnumType

type GNMIRpc_SubscribeMode 

type GNMIRpc_SubscribeMode int32

SubscribeMode, describes how updates are triggered for the request. 

const (
	GNMIRpc_UNSPECIFIED_SUBSCRIBE_MODE GNMIRpc_SubscribeMode = 0
	GNMIRpc_NO_READ_SUPPORT            GNMIRpc_SubscribeMode = 1 // No requirement / support for path.
	GNMIRpc_STREAM                     GNMIRpc_SubscribeMode = 2 // Values streamed by the target (Sec. 3.5.1.5.2).
	GNMIRpc_ONCE                       GNMIRpc_SubscribeMode = 3 // Values sent once-off by the target (Sec. 3.5.1.5.1).
	GNMIRpc_POLL                       GNMIRpc_SubscribeMode = 4 // Values sent in response to a poll request (Sec. 3.5.1.5.3).
)

func (GNMIRpc_SubscribeMode) Descriptor 

func (GNMIRpc_SubscribeMode) Descriptor() protoreflect.EnumDescriptor

func (GNMIRpc_SubscribeMode) Enum 

func (x GNMIRpc_SubscribeMode) Enum() *GNMIRpc_SubscribeMode

func (GNMIRpc_SubscribeMode) EnumDescriptor deprecated 

func (GNMIRpc_SubscribeMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use GNMIRpc_SubscribeMode.Descriptor instead.

func (GNMIRpc_SubscribeMode) Number 

func (x GNMIRpc_SubscribeMode) Number() protoreflect.EnumNumber

func (GNMIRpc_SubscribeMode) String 

func (x GNMIRpc_SubscribeMode) String() string

func (GNMIRpc_SubscribeMode) Type 

func (GNMIRpc_SubscribeMode) Type() protoreflect.EnumType

type OCPath 

type OCPath struct {

	// Flattened OC path without prefixes.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies a limited portion of the OC model that a given path is needed to
	// support.
	OcpathConstraint *OCPathConstraint `protobuf:"bytes,2,opt,name=ocpath_constraint,json=ocpathConstraint,proto3" json:"ocpath_constraint,omitempty"`
	// Suffix for featureprofiles/feature/<featureprofileid> to which this OCPath
	// is associated.
	// The string must match openconfig.profiles.FeatureProfileID in
	// https://github.com/openconfig/featureprofiles/blob/main/proto/feature.proto.
	// This destination featureprofiles folder serves as a grouping of the paths
	// related to the tests which appear in this folder and subfolders the folder.
	Featureprofileid string `protobuf:"bytes,3,opt,name=featureprofileid,proto3" json:"featureprofileid,omitempty"`
	// A set of opaque tags that are used for this path. These tags can be used
	// to group paths according to use-case specific criteria.
	Tags []string `protobuf:"bytes,4,rep,name=tags,proto3" json:"tags,omitempty"`
	// GNMIRpc describes expected (or supported) behavior for a particular
	// Openconfig path.
	GnmiRpc *GNMIRpc `protobuf:"bytes,5,opt,name=gnmi_rpc,json=gnmiRpc,proto3" json:"gnmi_rpc,omitempty"`
	// contains filtered or unexported fields
}

OCPath is an individual OpenConfig path path.

func (*OCPath) Descriptor deprecated 

func (*OCPath) Descriptor() ([]byte, []int)

Deprecated: Use OCPath.ProtoReflect.Descriptor instead.

func (*OCPath) GetFeatureprofileid 

func (x *OCPath) GetFeatureprofileid() string

func (*OCPath) GetGnmiRpc 

func (x *OCPath) GetGnmiRpc() *GNMIRpc

func (*OCPath) GetName 

func (x *OCPath) GetName() string

func (*OCPath) GetOcpathConstraint 

func (x *OCPath) GetOcpathConstraint() *OCPathConstraint

func (*OCPath) GetTags 

func (x *OCPath) GetTags() []string

func (*OCPath) ProtoMessage 

func (*OCPath) ProtoMessage()

func (*OCPath) ProtoReflect 

func (x *OCPath) ProtoReflect() protoreflect.Message

func (*OCPath) Reset 

func (x *OCPath) Reset()

func (*OCPath) String 

func (x *OCPath) String() string

type OCPathConstraint 

type OCPathConstraint struct {

	// Types that are valid to be assigned to Constraint:
	//
	//	*OCPathConstraint_PlatformType
	Constraint isOCPathConstraint_Constraint `protobuf_oneof:"constraint"`
	// contains filtered or unexported fields
}

OCPathConstraint enumerates platform_types that are required to be supported for all /components/component paths. All OCPath.name which contain a /components/component path, must also set the oc-platform-type the path applies to. OCPathConstraint may be used for any other oc paths when a subset of types, enums or identities are required.

For example, the path /components/component/state/software-version could have platform_type constraints of BIOS, BOOT_LOADER and OPERATING_SYSTEM

In the future, additional types of constraints can be defined by adding more fields for each type of constraint

func (*OCPathConstraint) Descriptor deprecated 

func (*OCPathConstraint) Descriptor() ([]byte, []int)

Deprecated: Use OCPathConstraint.ProtoReflect.Descriptor instead.

func (*OCPathConstraint) GetConstraint 

func (x *OCPathConstraint) GetConstraint() isOCPathConstraint_Constraint

func (*OCPathConstraint) GetPlatformType 

func (x *OCPathConstraint) GetPlatformType() string

func (*OCPathConstraint) ProtoMessage 

func (*OCPathConstraint) ProtoMessage()

func (*OCPathConstraint) ProtoReflect 

func (x *OCPathConstraint) ProtoReflect() protoreflect.Message

func (*OCPathConstraint) Reset 

func (x *OCPathConstraint) Reset()

func (*OCPathConstraint) String 

func (x *OCPathConstraint) String() string

type OCPathConstraint_PlatformType 

type OCPathConstraint_PlatformType struct {
	PlatformType string `protobuf:"bytes,1,opt,name=platform_type,json=platformType,proto3,oneof"`
}

type OCPaths 

type OCPaths struct {

	// Required OpenConfig paths for this entity.
	Ocpaths []*OCPath `protobuf:"bytes,1,rep,name=ocpaths,proto3" json:"ocpaths,omitempty"`
	// The semantic version of the OpenConfig public models release
	// (https://github.com/openconfig/public) associated with the list of
	// OpenConfig paths.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

OCPaths is the complete list of all OpenConfig paths associated with some entity (e.g. NOS, or path requirements list for a particular device role).

func (*OCPaths) Descriptor deprecated 

func (*OCPaths) Descriptor() ([]byte, []int)

Deprecated: Use OCPaths.ProtoReflect.Descriptor instead.

func (*OCPaths) GetOcpaths 

func (x *OCPaths) GetOcpaths() []*OCPath

func (*OCPaths) GetVersion 

func (x *OCPaths) GetVersion() string

func (*OCPaths) ProtoMessage 

func (*OCPaths) ProtoMessage()

func (*OCPaths) ProtoReflect 

func (x *OCPaths) ProtoReflect() protoreflect.Message

func (*OCPaths) Reset 

func (x *OCPaths) Reset()

func (*OCPaths) String 

func (x *OCPaths) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.