gnmi

package
Version: v0.0.0-...-aed1ee4 Latest Latest
Warning

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

Go to latest
Published: Feb 26, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Encoding_name = map[int32]string{
		0: "JSON",
		1: "BYTES",
		2: "PROTO",
		3: "ASCII",
		4: "JSON_IETF",
	}
	Encoding_value = map[string]int32{
		"JSON":      0,
		"BYTES":     1,
		"PROTO":     2,
		"ASCII":     3,
		"JSON_IETF": 4,
	}
)

Enum value maps for Encoding.

View Source
var (
	SubscriptionMode_name = map[int32]string{
		0: "TARGET_DEFINED",
		1: "ON_CHANGE",
		2: "SAMPLE",
	}
	SubscriptionMode_value = map[string]int32{
		"TARGET_DEFINED": 0,
		"ON_CHANGE":      1,
		"SAMPLE":         2,
	}
)

Enum value maps for SubscriptionMode.

View Source
var (
	SubscriptionList_Mode_name = map[int32]string{
		0: "STREAM",
		1: "ONCE",
		2: "POLL",
	}
	SubscriptionList_Mode_value = map[string]int32{
		"STREAM": 0,
		"ONCE":   1,
		"POLL":   2,
	}
)

Enum value maps for SubscriptionList_Mode.

View Source
var (
	UpdateResult_Operation_name = map[int32]string{
		0: "INVALID",
		1: "DELETE",
		2: "REPLACE",
		3: "UPDATE",
	}
	UpdateResult_Operation_value = map[string]int32{
		"INVALID": 0,
		"DELETE":  1,
		"REPLACE": 2,
		"UPDATE":  3,
	}
)

Enum value maps for UpdateResult_Operation.

View Source
var (
	GetRequest_DataType_name = map[int32]string{
		0: "ALL",
		1: "CONFIG",
		2: "STATE",
		3: "OPERATIONAL",
	}
	GetRequest_DataType_value = map[string]int32{
		"ALL":         0,
		"CONFIG":      1,
		"STATE":       2,
		"OPERATIONAL": 3,
	}
)

Enum value maps for GetRequest_DataType.

View Source
var (
	// The gNMI service semantic version.
	//
	// optional string gnmi_service = 1001;
	E_GnmiService = &file_proto_gnmi_gnmi_proto_extTypes[0]
)

Extension fields to descriptor.FileOptions.

View Source
var File_proto_gnmi_gnmi_proto protoreflect.FileDescriptor

Functions

func RegisterGNMIServer

func RegisterGNMIServer(s *grpc.Server, srv GNMIServer)

Types

type Alias

type Alias struct {
	Path  *Path  `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`   // The path to be aliased.
	Alias string `protobuf:"bytes,2,opt,name=alias,proto3" json:"alias,omitempty"` // The alias value, a string prefixed by "#".
	// contains filtered or unexported fields
}

Alias specifies a data tree path, and an associated string which defines an alias which is to be used for this path in the context of the RPC. The alias is specified as a string which is prefixed with "#" to disambiguate it from data tree element paths. Reference: gNMI Specification Section 2.4.2

func (*Alias) Descriptor deprecated

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

Deprecated: Use Alias.ProtoReflect.Descriptor instead.

func (*Alias) GetAlias

func (x *Alias) GetAlias() string

func (*Alias) GetPath

func (x *Alias) GetPath() *Path

func (*Alias) ProtoMessage

func (*Alias) ProtoMessage()

func (*Alias) ProtoReflect

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

func (*Alias) Reset

func (x *Alias) Reset()

func (*Alias) String

func (x *Alias) String() string

type AliasList

type AliasList struct {
	Alias []*Alias `protobuf:"bytes,1,rep,name=alias,proto3" json:"alias,omitempty"` // The set of aliases to be created.
	// contains filtered or unexported fields
}

AliasList specifies a list of aliases. It is used in a SubscribeRequest for a client to create a set of aliases that the target is to utilize. Reference: gNMI Specification Section 3.5.1.6

func (*AliasList) Descriptor deprecated

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

Deprecated: Use AliasList.ProtoReflect.Descriptor instead.

func (*AliasList) GetAlias

func (x *AliasList) GetAlias() []*Alias

func (*AliasList) ProtoMessage

func (*AliasList) ProtoMessage()

func (*AliasList) ProtoReflect

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

func (*AliasList) Reset

func (x *AliasList) Reset()

func (*AliasList) String

func (x *AliasList) String() string

type CapabilityRequest

type CapabilityRequest struct {

	// Extension messages associated with the CapabilityRequest. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,1,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

CapabilityRequest is sent by the client in the Capabilities RPC to request that the target reports its capabilities. Reference: gNMI Specification Section 3.2.1

func (*CapabilityRequest) Descriptor deprecated

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

Deprecated: Use CapabilityRequest.ProtoReflect.Descriptor instead.

func (*CapabilityRequest) GetExtension

func (x *CapabilityRequest) GetExtension() []*gnmi_ext.Extension

func (*CapabilityRequest) ProtoMessage

func (*CapabilityRequest) ProtoMessage()

func (*CapabilityRequest) ProtoReflect

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

func (*CapabilityRequest) Reset

func (x *CapabilityRequest) Reset()

func (*CapabilityRequest) String

func (x *CapabilityRequest) String() string

type CapabilityResponse

type CapabilityResponse struct {
	SupportedModels    []*ModelData `protobuf:"bytes,1,rep,name=supported_models,json=supportedModels,proto3" json:"supported_models,omitempty"` // Supported schema models.
	SupportedEncodings []Encoding   ``                                                                                                           // Supported encodings.
	/* 142-byte string literal not displayed */
	GNMIVersion string `protobuf:"bytes,3,opt,name=gNMI_version,json=gNMIVersion,proto3" json:"gNMI_version,omitempty"` // Supported gNMI version.
	// Extension messages associated with the CapabilityResponse. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,4,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

CapabilityResponse is used by the target to report its capabilities to the client within the Capabilities RPC. Reference: gNMI Specification Section 3.2.2

func (*CapabilityResponse) Descriptor deprecated

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

Deprecated: Use CapabilityResponse.ProtoReflect.Descriptor instead.

func (*CapabilityResponse) GetExtension

func (x *CapabilityResponse) GetExtension() []*gnmi_ext.Extension

func (*CapabilityResponse) GetGNMIVersion

func (x *CapabilityResponse) GetGNMIVersion() string

func (*CapabilityResponse) GetSupportedEncodings

func (x *CapabilityResponse) GetSupportedEncodings() []Encoding

func (*CapabilityResponse) GetSupportedModels

func (x *CapabilityResponse) GetSupportedModels() []*ModelData

func (*CapabilityResponse) ProtoMessage

func (*CapabilityResponse) ProtoMessage()

func (*CapabilityResponse) ProtoReflect

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

func (*CapabilityResponse) Reset

func (x *CapabilityResponse) Reset()

func (*CapabilityResponse) String

func (x *CapabilityResponse) String() string

type Decimal64

type Decimal64 struct {
	Digits    int64  `protobuf:"varint,1,opt,name=digits,proto3" json:"digits,omitempty"`       // Set of digits.
	Precision uint32 `protobuf:"varint,2,opt,name=precision,proto3" json:"precision,omitempty"` // Number of digits following the decimal point.
	// contains filtered or unexported fields
}

Decimal64 is used to encode a fixed precision decimal number. The value is expressed as a set of digits with the precision specifying the number of digits following the decimal point in the digit set.

func (*Decimal64) Descriptor deprecated

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

Deprecated: Use Decimal64.ProtoReflect.Descriptor instead.

func (*Decimal64) GetDigits

func (x *Decimal64) GetDigits() int64

func (*Decimal64) GetPrecision

func (x *Decimal64) GetPrecision() uint32

func (*Decimal64) ProtoMessage

func (*Decimal64) ProtoMessage()

func (*Decimal64) ProtoReflect

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

func (*Decimal64) Reset

func (x *Decimal64) Reset()

func (*Decimal64) String

func (x *Decimal64) String() string

type Encoding

type Encoding int32

Encoding defines the value encoding formats that are supported by the gNMI protocol. These encodings are used by both the client (when sending Set messages to modify the state of the target) and the target when serializing data to be returned to the client (in both Subscribe and Get RPCs). Reference: gNMI Specification Section 2.3

const (
	Encoding_JSON      Encoding = 0 // JSON encoded text.
	Encoding_BYTES     Encoding = 1 // Arbitrarily encoded bytes.
	Encoding_PROTO     Encoding = 2 // Encoded according to out-of-band agreed Protobuf.
	Encoding_ASCII     Encoding = 3 // ASCII text of an out-of-band agreed format.
	Encoding_JSON_IETF Encoding = 4 // JSON encoded text as per RFC7951.
)

func (Encoding) Descriptor

func (Encoding) Descriptor() protoreflect.EnumDescriptor

func (Encoding) Enum

func (x Encoding) Enum() *Encoding

func (Encoding) EnumDescriptor deprecated

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

Deprecated: Use Encoding.Descriptor instead.

func (Encoding) Number

func (x Encoding) Number() protoreflect.EnumNumber

func (Encoding) String

func (x Encoding) String() string

func (Encoding) Type

type Error deprecated

type Error struct {
	Code    uint32   `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`      // Canonical gRPC error code.
	Message string   `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // Human readable error.
	Data    *any.Any `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`       // Optional additional information.
	// contains filtered or unexported fields
}

Error message previously utilised to return errors to the client. Deprecated in favour of using the google.golang.org/genproto/googleapis/rpc/status message in the RPC response. Reference: gNMI Specification Section 2.5

Deprecated: Do not use.

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode

func (x *Error) GetCode() uint32

func (*Error) GetData

func (x *Error) GetData() *any.Any

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type GNMIClient

type GNMIClient interface {
	// Capabilities allows the client to retrieve the set of capabilities that
	// is supported by the target. This allows the target to validate the
	// service version that is implemented and retrieve the set of models that
	// the target supports. The models can then be specified in subsequent RPCs
	// to restrict the set of data that is utilized.
	// Reference: gNMI Specification Section 3.2
	Capabilities(ctx context.Context, in *CapabilityRequest, opts ...grpc.CallOption) (*CapabilityResponse, error)
	// Retrieve a snapshot of data from the target. A Get RPC requests that the
	// target snapshots a subset of the data tree as specified by the paths
	// included in the message and serializes this to be returned to the
	// client using the specified encoding.
	// Reference: gNMI Specification Section 3.3
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// Set allows the client to modify the state of data on the target. The
	// paths to modified along with the new values that the client wishes
	// to set the value to.
	// Reference: gNMI Specification Section 3.4
	Set(ctx context.Context, in *SetRequest, opts ...grpc.CallOption) (*SetResponse, error)
	// Subscribe allows a client to request the target to send it values
	// of particular paths within the data tree. These values may be streamed
	// at a particular cadence (STREAM), sent one off on a long-lived channel
	// (POLL), or sent as a one-off retrieval (ONCE).
	// Reference: gNMI Specification Section 3.5
	Subscribe(ctx context.Context, opts ...grpc.CallOption) (GNMI_SubscribeClient, error)
}

GNMIClient is the client API for GNMI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewGNMIClient

func NewGNMIClient(cc grpc.ClientConnInterface) GNMIClient

type GNMIServer

type GNMIServer interface {
	// Capabilities allows the client to retrieve the set of capabilities that
	// is supported by the target. This allows the target to validate the
	// service version that is implemented and retrieve the set of models that
	// the target supports. The models can then be specified in subsequent RPCs
	// to restrict the set of data that is utilized.
	// Reference: gNMI Specification Section 3.2
	Capabilities(context.Context, *CapabilityRequest) (*CapabilityResponse, error)
	// Retrieve a snapshot of data from the target. A Get RPC requests that the
	// target snapshots a subset of the data tree as specified by the paths
	// included in the message and serializes this to be returned to the
	// client using the specified encoding.
	// Reference: gNMI Specification Section 3.3
	Get(context.Context, *GetRequest) (*GetResponse, error)
	// Set allows the client to modify the state of data on the target. The
	// paths to modified along with the new values that the client wishes
	// to set the value to.
	// Reference: gNMI Specification Section 3.4
	Set(context.Context, *SetRequest) (*SetResponse, error)
	// Subscribe allows a client to request the target to send it values
	// of particular paths within the data tree. These values may be streamed
	// at a particular cadence (STREAM), sent one off on a long-lived channel
	// (POLL), or sent as a one-off retrieval (ONCE).
	// Reference: gNMI Specification Section 3.5
	Subscribe(GNMI_SubscribeServer) error
}

GNMIServer is the server API for GNMI service.

type GNMI_SubscribeClient

type GNMI_SubscribeClient interface {
	Send(*SubscribeRequest) error
	Recv() (*SubscribeResponse, error)
	grpc.ClientStream
}

type GNMI_SubscribeServer

type GNMI_SubscribeServer interface {
	Send(*SubscribeResponse) error
	Recv() (*SubscribeRequest, error)
	grpc.ServerStream
}

type GetRequest

type GetRequest struct {
	Prefix    *Path               `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`                            // Prefix used for paths.
	Path      []*Path             `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"`                                // Paths requested by the client.
	Type      GetRequest_DataType `protobuf:"varint,3,opt,name=type,proto3,enum=gnmi.GetRequest_DataType" json:"type,omitempty"` // The type of data being requested.
	Encoding  Encoding            `protobuf:"varint,5,opt,name=encoding,proto3,enum=gnmi.Encoding" json:"encoding,omitempty"`    // Encoding to be used.
	UseModels []*ModelData        `protobuf:"bytes,6,rep,name=use_models,json=useModels,proto3" json:"use_models,omitempty"`     // The schema models to be used.
	// Extension messages associated with the GetRequest. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,7,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

GetRequest is sent when a client initiates a Get RPC. It is used to specify the set of data elements for which the target should return a snapshot of data. The use_models field specifies the set of schema modules that are to be used by the target - where use_models is not specified then the target must use all schema models that it has. Reference: gNMI Specification Section 3.3.1

func (*GetRequest) Descriptor deprecated

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

Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.

func (*GetRequest) GetEncoding

func (x *GetRequest) GetEncoding() Encoding

func (*GetRequest) GetExtension

func (x *GetRequest) GetExtension() []*gnmi_ext.Extension

func (*GetRequest) GetPath

func (x *GetRequest) GetPath() []*Path

func (*GetRequest) GetPrefix

func (x *GetRequest) GetPrefix() *Path

func (*GetRequest) GetType

func (x *GetRequest) GetType() GetRequest_DataType

func (*GetRequest) GetUseModels

func (x *GetRequest) GetUseModels() []*ModelData

func (*GetRequest) ProtoMessage

func (*GetRequest) ProtoMessage()

func (*GetRequest) ProtoReflect

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

func (*GetRequest) Reset

func (x *GetRequest) Reset()

func (*GetRequest) String

func (x *GetRequest) String() string

type GetRequest_DataType

type GetRequest_DataType int32

Type of elements within the data tree.

const (
	GetRequest_ALL    GetRequest_DataType = 0 // All data elements.
	GetRequest_CONFIG GetRequest_DataType = 1 // Config (rw) only elements.
	GetRequest_STATE  GetRequest_DataType = 2 // State (ro) only elements.
	// Data elements marked in the schema as operational. This refers to data
	// elements whose value relates to the state of processes or interactions
	// running on the device.
	GetRequest_OPERATIONAL GetRequest_DataType = 3
)

func (GetRequest_DataType) Descriptor

func (GetRequest_DataType) Enum

func (GetRequest_DataType) EnumDescriptor deprecated

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

Deprecated: Use GetRequest_DataType.Descriptor instead.

func (GetRequest_DataType) Number

func (GetRequest_DataType) String

func (x GetRequest_DataType) String() string

func (GetRequest_DataType) Type

type GetResponse

type GetResponse struct {
	Notification []*Notification `protobuf:"bytes,1,rep,name=notification,proto3" json:"notification,omitempty"` // Data values.
	// Deprecated: Do not use.
	Error *Error `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // Errors that occurred in the Get.
	// Extension messages associated with the GetResponse. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,3,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

GetResponse is used by the target to respond to a GetRequest from a client. The set of Notifications corresponds to the data values that are requested by the client in the GetRequest. Reference: gNMI Specification Section 3.3.2

func (*GetResponse) Descriptor deprecated

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

Deprecated: Use GetResponse.ProtoReflect.Descriptor instead.

func (*GetResponse) GetError deprecated

func (x *GetResponse) GetError() *Error

Deprecated: Do not use.

func (*GetResponse) GetExtension

func (x *GetResponse) GetExtension() []*gnmi_ext.Extension

func (*GetResponse) GetNotification

func (x *GetResponse) GetNotification() []*Notification

func (*GetResponse) ProtoMessage

func (*GetResponse) ProtoMessage()

func (*GetResponse) ProtoReflect

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

func (*GetResponse) Reset

func (x *GetResponse) Reset()

func (*GetResponse) String

func (x *GetResponse) String() string

type ModelData

type ModelData struct {
	Name         string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`                 // Name of the model.
	Organization string `protobuf:"bytes,2,opt,name=organization,proto3" json:"organization,omitempty"` // Organization publishing the model.
	Version      string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`           // Semantic version of the model.
	// contains filtered or unexported fields
}

ModelData is used to describe a set of schema modules. It can be used in a CapabilityResponse where a target reports the set of modules that it supports, and within the SubscribeRequest and GetRequest messages to specify the set of models from which data tree elements should be reported. Reference: gNMI Specification Section 3.2.3

func (*ModelData) Descriptor deprecated

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

Deprecated: Use ModelData.ProtoReflect.Descriptor instead.

func (*ModelData) GetName

func (x *ModelData) GetName() string

func (*ModelData) GetOrganization

func (x *ModelData) GetOrganization() string

func (*ModelData) GetVersion

func (x *ModelData) GetVersion() string

func (*ModelData) ProtoMessage

func (*ModelData) ProtoMessage()

func (*ModelData) ProtoReflect

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

func (*ModelData) Reset

func (x *ModelData) Reset()

func (*ModelData) String

func (x *ModelData) String() string

type Notification

type Notification struct {
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // Timestamp in nanoseconds since Epoch.
	Prefix    *Path `protobuf:"bytes,2,opt,name=prefix,proto3" json:"prefix,omitempty"`        // Prefix used for paths in the message.
	// An alias for the path specified in the prefix field.
	// Reference: gNMI Specification Section 2.4.2
	Alias  string    `protobuf:"bytes,3,opt,name=alias,proto3" json:"alias,omitempty"`
	Update []*Update `protobuf:"bytes,4,rep,name=update,proto3" json:"update,omitempty"` // Data elements that have changed values.
	Delete []*Path   `protobuf:"bytes,5,rep,name=delete,proto3" json:"delete,omitempty"` // Data elements that have been deleted.
	// This notification contains a set of paths that are always updated together
	// referenced by a globally unique prefix.
	Atomic bool `protobuf:"varint,6,opt,name=atomic,proto3" json:"atomic,omitempty"`
	// contains filtered or unexported fields
}

Notification is a re-usable message that is used to encode data from the target to the client. A Notification carries two types of changes to the data tree:

- Deleted values (delete) - a set of paths that have been removed from the
  data tree.
- Updated values (update) - a set of path-value pairs indicating the path
  whose value has changed in the data tree.

Reference: gNMI Specification Section 2.1

func (*Notification) Descriptor deprecated

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

Deprecated: Use Notification.ProtoReflect.Descriptor instead.

func (*Notification) GetAlias

func (x *Notification) GetAlias() string

func (*Notification) GetAtomic

func (x *Notification) GetAtomic() bool

func (*Notification) GetDelete

func (x *Notification) GetDelete() []*Path

func (*Notification) GetPrefix

func (x *Notification) GetPrefix() *Path

func (*Notification) GetTimestamp

func (x *Notification) GetTimestamp() int64

func (*Notification) GetUpdate

func (x *Notification) GetUpdate() []*Update

func (*Notification) ProtoMessage

func (*Notification) ProtoMessage()

func (*Notification) ProtoReflect

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

func (*Notification) Reset

func (x *Notification) Reset()

func (*Notification) String

func (x *Notification) String() string

type Path

type Path struct {

	// Elements of the path are no longer encoded as a string, but rather within
	// the elem field as a PathElem message.
	//
	// Deprecated: Do not use.
	Element []string    `protobuf:"bytes,1,rep,name=element,proto3" json:"element,omitempty"`
	Origin  string      `protobuf:"bytes,2,opt,name=origin,proto3" json:"origin,omitempty"` // Label to disambiguate path.
	Elem    []*PathElem `protobuf:"bytes,3,rep,name=elem,proto3" json:"elem,omitempty"`     // Elements of the path.
	Target  string      `protobuf:"bytes,4,opt,name=target,proto3" json:"target,omitempty"` // The name of the target
	// contains filtered or unexported fields
}

Path encodes a data tree path as a series of repeated strings, with each element of the path representing a data tree node name and the associated attributes. Reference: gNMI Specification Section 2.2.2.

func (*Path) Descriptor deprecated

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

Deprecated: Use Path.ProtoReflect.Descriptor instead.

func (*Path) GetElem

func (x *Path) GetElem() []*PathElem

func (*Path) GetElement deprecated

func (x *Path) GetElement() []string

Deprecated: Do not use.

func (*Path) GetOrigin

func (x *Path) GetOrigin() string

func (*Path) GetTarget

func (x *Path) GetTarget() string

func (*Path) ProtoMessage

func (*Path) ProtoMessage()

func (*Path) ProtoReflect

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

func (*Path) Reset

func (x *Path) Reset()

func (*Path) String

func (x *Path) String() string

type PathElem

type PathElem struct {
	Name string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The name of the element in the path.
	Key  map[string]string ``                                                              // Map of key (attribute) name to value.
	/* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

PathElem encodes an element of a gNMI path, along with any attributes (keys) that may be associated with it. Reference: gNMI Specification Section 2.2.2.

func (*PathElem) Descriptor deprecated

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

Deprecated: Use PathElem.ProtoReflect.Descriptor instead.

func (*PathElem) GetKey

func (x *PathElem) GetKey() map[string]string

func (*PathElem) GetName

func (x *PathElem) GetName() string

func (*PathElem) ProtoMessage

func (*PathElem) ProtoMessage()

func (*PathElem) ProtoReflect

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

func (*PathElem) Reset

func (x *PathElem) Reset()

func (*PathElem) String

func (x *PathElem) String() string

type Poll

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

Poll is sent within a SubscribeRequest to trigger the device to send telemetry updates for the paths that are associated with the subscription. Reference: gNMI Specification Section Section 3.5.1.4

func (*Poll) Descriptor deprecated

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

Deprecated: Use Poll.ProtoReflect.Descriptor instead.

func (*Poll) ProtoMessage

func (*Poll) ProtoMessage()

func (*Poll) ProtoReflect

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

func (*Poll) Reset

func (x *Poll) Reset()

func (*Poll) String

func (x *Poll) String() string

type QOSMarking

type QOSMarking struct {
	Marking uint32 `protobuf:"varint,1,opt,name=marking,proto3" json:"marking,omitempty"`
	// contains filtered or unexported fields
}

QOSMarking specifies the DSCP value to be set on transmitted telemetry updates from the target. Reference: gNMI Specification Section 3.5.1.2

func (*QOSMarking) Descriptor deprecated

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

Deprecated: Use QOSMarking.ProtoReflect.Descriptor instead.

func (*QOSMarking) GetMarking

func (x *QOSMarking) GetMarking() uint32

func (*QOSMarking) ProtoMessage

func (*QOSMarking) ProtoMessage()

func (*QOSMarking) ProtoReflect

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

func (*QOSMarking) Reset

func (x *QOSMarking) Reset()

func (*QOSMarking) String

func (x *QOSMarking) String() string

type ScalarArray

type ScalarArray struct {

	// The set of elements within the array. Each TypedValue message should
	// specify only elements that have a field identifier of 1-7 (i.e., the
	// values are scalar values).
	Element []*TypedValue `protobuf:"bytes,1,rep,name=element,proto3" json:"element,omitempty"`
	// contains filtered or unexported fields
}

ScalarArray is used to encode a mixed-type array of values.

func (*ScalarArray) Descriptor deprecated

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

Deprecated: Use ScalarArray.ProtoReflect.Descriptor instead.

func (*ScalarArray) GetElement

func (x *ScalarArray) GetElement() []*TypedValue

func (*ScalarArray) ProtoMessage

func (*ScalarArray) ProtoMessage()

func (*ScalarArray) ProtoReflect

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

func (*ScalarArray) Reset

func (x *ScalarArray) Reset()

func (*ScalarArray) String

func (x *ScalarArray) String() string

type SetRequest

type SetRequest struct {
	Prefix  *Path     `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`   // Prefix used for paths in the message.
	Delete  []*Path   `protobuf:"bytes,2,rep,name=delete,proto3" json:"delete,omitempty"`   // Paths to be deleted from the data tree.
	Replace []*Update `protobuf:"bytes,3,rep,name=replace,proto3" json:"replace,omitempty"` // Updates specifying elements to be replaced.
	Update  []*Update `protobuf:"bytes,4,rep,name=update,proto3" json:"update,omitempty"`   // Updates specifying elements to updated.
	// Extension messages associated with the SetRequest. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

SetRequest is sent from a client to the target to update values in the data tree. Paths are either deleted by the client, or modified by means of being updated, or replaced. Where a replace is used, unspecified values are considered to be replaced, whereas when update is used the changes are considered to be incremental. The set of changes that are specified within a single SetRequest are considered to be a transaction. Reference: gNMI Specification Section 3.4.1

func (*SetRequest) Descriptor deprecated

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

Deprecated: Use SetRequest.ProtoReflect.Descriptor instead.

func (*SetRequest) GetDelete

func (x *SetRequest) GetDelete() []*Path

func (*SetRequest) GetExtension

func (x *SetRequest) GetExtension() []*gnmi_ext.Extension

func (*SetRequest) GetPrefix

func (x *SetRequest) GetPrefix() *Path

func (*SetRequest) GetReplace

func (x *SetRequest) GetReplace() []*Update

func (*SetRequest) GetUpdate

func (x *SetRequest) GetUpdate() []*Update

func (*SetRequest) ProtoMessage

func (*SetRequest) ProtoMessage()

func (*SetRequest) ProtoReflect

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

func (*SetRequest) Reset

func (x *SetRequest) Reset()

func (*SetRequest) String

func (x *SetRequest) String() string

type SetResponse

type SetResponse struct {
	Prefix *Path `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"` // Prefix used for paths.
	// A set of responses specifying the result of the operations specified in
	// the SetRequest.
	Response []*UpdateResult `protobuf:"bytes,2,rep,name=response,proto3" json:"response,omitempty"`
	// Deprecated: Do not use.
	Message   *Error `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`      // The overall status of the transaction.
	Timestamp int64  `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // Timestamp of transaction (ns since epoch).
	// Extension messages associated with the SetResponse. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

SetResponse is the response to a SetRequest, sent from the target to the client. It reports the result of the modifications to the data tree that were specified by the client. Errors for this RPC should be reported using the https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto message in the RPC return. The gnmi.Error message can be used to add additional details where required. Reference: gNMI Specification Section 3.4.2

func (*SetResponse) Descriptor deprecated

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

Deprecated: Use SetResponse.ProtoReflect.Descriptor instead.

func (*SetResponse) GetExtension

func (x *SetResponse) GetExtension() []*gnmi_ext.Extension

func (*SetResponse) GetMessage deprecated

func (x *SetResponse) GetMessage() *Error

Deprecated: Do not use.

func (*SetResponse) GetPrefix

func (x *SetResponse) GetPrefix() *Path

func (*SetResponse) GetResponse

func (x *SetResponse) GetResponse() []*UpdateResult

func (*SetResponse) GetTimestamp

func (x *SetResponse) GetTimestamp() int64

func (*SetResponse) ProtoMessage

func (*SetResponse) ProtoMessage()

func (*SetResponse) ProtoReflect

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

func (*SetResponse) Reset

func (x *SetResponse) Reset()

func (*SetResponse) String

func (x *SetResponse) String() string

type SubscribeRequest

type SubscribeRequest struct {

	// Types that are assignable to Request:
	//	*SubscribeRequest_Subscribe
	//	*SubscribeRequest_Poll
	//	*SubscribeRequest_Aliases
	Request isSubscribeRequest_Request `protobuf_oneof:"request"`
	// Extension messages associated with the SubscribeRequest. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

SubscribeRequest is the message sent by the client to the target when initiating a subscription to a set of paths within the data tree. The request field must be populated and the initial message must specify a SubscriptionList to initiate a subscription. The message is subsequently used to define aliases or trigger polled data to be sent by the target. Reference: gNMI Specification Section 3.5.1.1

func (*SubscribeRequest) Descriptor deprecated

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

Deprecated: Use SubscribeRequest.ProtoReflect.Descriptor instead.

func (*SubscribeRequest) GetAliases

func (x *SubscribeRequest) GetAliases() *AliasList

func (*SubscribeRequest) GetExtension

func (x *SubscribeRequest) GetExtension() []*gnmi_ext.Extension

func (*SubscribeRequest) GetPoll

func (x *SubscribeRequest) GetPoll() *Poll

func (*SubscribeRequest) GetRequest

func (m *SubscribeRequest) GetRequest() isSubscribeRequest_Request

func (*SubscribeRequest) GetSubscribe

func (x *SubscribeRequest) GetSubscribe() *SubscriptionList

func (*SubscribeRequest) ProtoMessage

func (*SubscribeRequest) ProtoMessage()

func (*SubscribeRequest) ProtoReflect

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

func (*SubscribeRequest) Reset

func (x *SubscribeRequest) Reset()

func (*SubscribeRequest) String

func (x *SubscribeRequest) String() string

type SubscribeRequest_Aliases

type SubscribeRequest_Aliases struct {
	Aliases *AliasList `protobuf:"bytes,4,opt,name=aliases,proto3,oneof"` // Aliases to be created.
}

type SubscribeRequest_Poll

type SubscribeRequest_Poll struct {
	Poll *Poll `protobuf:"bytes,3,opt,name=poll,proto3,oneof"` // Trigger a polled update.
}

type SubscribeRequest_Subscribe

type SubscribeRequest_Subscribe struct {
	Subscribe *SubscriptionList `protobuf:"bytes,1,opt,name=subscribe,proto3,oneof"` // Specify the paths within a subscription.
}

type SubscribeResponse

type SubscribeResponse struct {

	// Types that are assignable to Response:
	//	*SubscribeResponse_Update
	//	*SubscribeResponse_SyncResponse
	//	*SubscribeResponse_Error
	Response isSubscribeResponse_Response `protobuf_oneof:"response"`
	// Extension messages associated with the SubscribeResponse. See the
	// gNMI extension specification for further definition.
	Extension []*gnmi_ext.Extension `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

SubscribeResponse is the message used by the target within a Subscribe RPC. The target includes a Notification message which is used to transmit values of the path(s) that are associated with the subscription. The same message is to indicate that the target has sent all data values once (is synchronized). Reference: gNMI Specification Section 3.5.1.4

func (*SubscribeResponse) Descriptor deprecated

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

Deprecated: Use SubscribeResponse.ProtoReflect.Descriptor instead.

func (*SubscribeResponse) GetError deprecated

func (x *SubscribeResponse) GetError() *Error

Deprecated: Do not use.

func (*SubscribeResponse) GetExtension

func (x *SubscribeResponse) GetExtension() []*gnmi_ext.Extension

func (*SubscribeResponse) GetResponse

func (m *SubscribeResponse) GetResponse() isSubscribeResponse_Response

func (*SubscribeResponse) GetSyncResponse

func (x *SubscribeResponse) GetSyncResponse() bool

func (*SubscribeResponse) GetUpdate

func (x *SubscribeResponse) GetUpdate() *Notification

func (*SubscribeResponse) ProtoMessage

func (*SubscribeResponse) ProtoMessage()

func (*SubscribeResponse) ProtoReflect

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

func (*SubscribeResponse) Reset

func (x *SubscribeResponse) Reset()

func (*SubscribeResponse) String

func (x *SubscribeResponse) String() string

type SubscribeResponse_Error

type SubscribeResponse_Error struct {
	// Deprecated in favour of google.golang.org/genproto/googleapis/rpc/status
	//
	// Deprecated: Do not use.
	Error *Error `protobuf:"bytes,4,opt,name=error,proto3,oneof"`
}

type SubscribeResponse_SyncResponse

type SubscribeResponse_SyncResponse struct {
	// Indicate target has sent all values associated with the subscription
	// at least once.
	SyncResponse bool `protobuf:"varint,3,opt,name=sync_response,json=syncResponse,proto3,oneof"`
}

type SubscribeResponse_Update

type SubscribeResponse_Update struct {
	Update *Notification `protobuf:"bytes,1,opt,name=update,proto3,oneof"` // Changed or sampled value for a path.
}

type Subscription

type Subscription struct {
	Path           *Path            `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`                                            // The data tree path.
	Mode           SubscriptionMode `protobuf:"varint,2,opt,name=mode,proto3,enum=gnmi.SubscriptionMode" json:"mode,omitempty"`                // Subscription mode to be used.
	SampleInterval uint64           `protobuf:"varint,3,opt,name=sample_interval,json=sampleInterval,proto3" json:"sample_interval,omitempty"` // ns between samples in SAMPLE mode.
	// Indicates whether values that have not changed should be sent in a SAMPLE
	// subscription.
	SuppressRedundant bool `protobuf:"varint,4,opt,name=suppress_redundant,json=suppressRedundant,proto3" json:"suppress_redundant,omitempty"`
	// Specifies the maximum allowable silent period in nanoseconds when
	// suppress_redundant is in use. The target should send a value at least once
	// in the period specified.
	HeartbeatInterval uint64 `protobuf:"varint,5,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"`
	// contains filtered or unexported fields
}

Subscription is a single request within a SubscriptionList. The path specified is interpreted (along with the prefix) as the elements of the data tree that the client is subscribing to. The mode determines how the target should trigger updates to be sent. Reference: gNMI Specification Section 3.5.1.3

func (*Subscription) Descriptor deprecated

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

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetHeartbeatInterval

func (x *Subscription) GetHeartbeatInterval() uint64

func (*Subscription) GetMode

func (x *Subscription) GetMode() SubscriptionMode

func (*Subscription) GetPath

func (x *Subscription) GetPath() *Path

func (*Subscription) GetSampleInterval

func (x *Subscription) GetSampleInterval() uint64

func (*Subscription) GetSuppressRedundant

func (x *Subscription) GetSuppressRedundant() bool

func (*Subscription) ProtoMessage

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect

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

func (*Subscription) Reset

func (x *Subscription) Reset()

func (*Subscription) String

func (x *Subscription) String() string

type SubscriptionList

type SubscriptionList struct {
	Prefix       *Path           `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`             // Prefix used for paths.
	Subscription []*Subscription `protobuf:"bytes,2,rep,name=subscription,proto3" json:"subscription,omitempty"` // Set of subscriptions to create.
	// Whether target defined aliases are allowed within the subscription.
	UseAliases bool                  `protobuf:"varint,3,opt,name=use_aliases,json=useAliases,proto3" json:"use_aliases,omitempty"`
	Qos        *QOSMarking           `protobuf:"bytes,4,opt,name=qos,proto3" json:"qos,omitempty"` // DSCP marking to be used.
	Mode       SubscriptionList_Mode `protobuf:"varint,5,opt,name=mode,proto3,enum=gnmi.SubscriptionList_Mode" json:"mode,omitempty"`
	// Whether elements of the schema that are marked as eligible for aggregation
	// should be aggregated or not.
	AllowAggregation bool `protobuf:"varint,6,opt,name=allow_aggregation,json=allowAggregation,proto3" json:"allow_aggregation,omitempty"`
	// The set of schemas that define the elements of the data tree that should
	// be sent by the target.
	UseModels []*ModelData `protobuf:"bytes,7,rep,name=use_models,json=useModels,proto3" json:"use_models,omitempty"`
	// The encoding that the target should use within the Notifications generated
	// corresponding to the SubscriptionList.
	Encoding Encoding `protobuf:"varint,8,opt,name=encoding,proto3,enum=gnmi.Encoding" json:"encoding,omitempty"`
	// An optional field to specify that only updates to current state should be
	// sent to a client. If set, the initial state is not sent to the client but
	// rather only the sync message followed by any subsequent updates to the
	// current state. For ONCE and POLL modes, this causes the server to send only
	// the sync message (Sec. 3.5.2.3).
	UpdatesOnly bool `protobuf:"varint,9,opt,name=updates_only,json=updatesOnly,proto3" json:"updates_only,omitempty"`
	// contains filtered or unexported fields
}

SubscriptionList is used within a Subscribe message to specify the list of paths that the client wishes to subscribe to. The message consists of a list of (possibly prefixed) paths, and options that relate to the subscription. Reference: gNMI Specification Section 3.5.1.2

func (*SubscriptionList) Descriptor deprecated

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

Deprecated: Use SubscriptionList.ProtoReflect.Descriptor instead.

func (*SubscriptionList) GetAllowAggregation

func (x *SubscriptionList) GetAllowAggregation() bool

func (*SubscriptionList) GetEncoding

func (x *SubscriptionList) GetEncoding() Encoding

func (*SubscriptionList) GetMode

func (*SubscriptionList) GetPrefix

func (x *SubscriptionList) GetPrefix() *Path

func (*SubscriptionList) GetQos

func (x *SubscriptionList) GetQos() *QOSMarking

func (*SubscriptionList) GetSubscription

func (x *SubscriptionList) GetSubscription() []*Subscription

func (*SubscriptionList) GetUpdatesOnly

func (x *SubscriptionList) GetUpdatesOnly() bool

func (*SubscriptionList) GetUseAliases

func (x *SubscriptionList) GetUseAliases() bool

func (*SubscriptionList) GetUseModels

func (x *SubscriptionList) GetUseModels() []*ModelData

func (*SubscriptionList) ProtoMessage

func (*SubscriptionList) ProtoMessage()

func (*SubscriptionList) ProtoReflect

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

func (*SubscriptionList) Reset

func (x *SubscriptionList) Reset()

func (*SubscriptionList) String

func (x *SubscriptionList) String() string

type SubscriptionList_Mode

type SubscriptionList_Mode int32

Mode of the subscription.

const (
	SubscriptionList_STREAM SubscriptionList_Mode = 0 // Values streamed by the target (Sec. 3.5.1.5.2).
	SubscriptionList_ONCE   SubscriptionList_Mode = 1 // Values sent once-off by the target (Sec. 3.5.1.5.1).
	SubscriptionList_POLL   SubscriptionList_Mode = 2 // Values sent in response to a poll request (Sec. 3.5.1.5.3).
)

func (SubscriptionList_Mode) Descriptor

func (SubscriptionList_Mode) Enum

func (SubscriptionList_Mode) EnumDescriptor deprecated

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

Deprecated: Use SubscriptionList_Mode.Descriptor instead.

func (SubscriptionList_Mode) Number

func (SubscriptionList_Mode) String

func (x SubscriptionList_Mode) String() string

func (SubscriptionList_Mode) Type

type SubscriptionMode

type SubscriptionMode int32

SubscriptionMode is the mode of the subscription, specifying how the target must return values in a subscription. Reference: gNMI Specification Section 3.5.1.3

const (
	SubscriptionMode_TARGET_DEFINED SubscriptionMode = 0 // The target selects the relevant mode for each element.
	SubscriptionMode_ON_CHANGE      SubscriptionMode = 1 // The target sends an update on element value change.
	SubscriptionMode_SAMPLE         SubscriptionMode = 2 // The target samples values according to the interval.
)

func (SubscriptionMode) Descriptor

func (SubscriptionMode) Enum

func (SubscriptionMode) EnumDescriptor deprecated

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

Deprecated: Use SubscriptionMode.Descriptor instead.

func (SubscriptionMode) Number

func (SubscriptionMode) String

func (x SubscriptionMode) String() string

func (SubscriptionMode) Type

type TypedValue

type TypedValue struct {

	// One of the fields within the val oneof is populated with the value
	// of the update. The type of the value being included in the Update
	// determines which field should be populated. In the case that the
	// encoding is a particular form of the base protobuf type, a specific
	// field is used to store the value (e.g., json_val).
	//
	// Types that are assignable to Value:
	//	*TypedValue_StringVal
	//	*TypedValue_IntVal
	//	*TypedValue_UintVal
	//	*TypedValue_BoolVal
	//	*TypedValue_BytesVal
	//	*TypedValue_FloatVal
	//	*TypedValue_DecimalVal
	//	*TypedValue_LeaflistVal
	//	*TypedValue_AnyVal
	//	*TypedValue_JsonVal
	//	*TypedValue_JsonIetfVal
	//	*TypedValue_AsciiVal
	//	*TypedValue_ProtoBytes
	Value isTypedValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

TypedValue is used to encode a value being sent between the client and target (originated by either entity).

func (*TypedValue) Descriptor deprecated

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

Deprecated: Use TypedValue.ProtoReflect.Descriptor instead.

func (*TypedValue) GetAnyVal

func (x *TypedValue) GetAnyVal() *any.Any

func (*TypedValue) GetAsciiVal

func (x *TypedValue) GetAsciiVal() string

func (*TypedValue) GetBoolVal

func (x *TypedValue) GetBoolVal() bool

func (*TypedValue) GetBytesVal

func (x *TypedValue) GetBytesVal() []byte

func (*TypedValue) GetDecimalVal

func (x *TypedValue) GetDecimalVal() *Decimal64

func (*TypedValue) GetFloatVal

func (x *TypedValue) GetFloatVal() float32

func (*TypedValue) GetIntVal

func (x *TypedValue) GetIntVal() int64

func (*TypedValue) GetJsonIetfVal

func (x *TypedValue) GetJsonIetfVal() []byte

func (*TypedValue) GetJsonVal

func (x *TypedValue) GetJsonVal() []byte

func (*TypedValue) GetLeaflistVal

func (x *TypedValue) GetLeaflistVal() *ScalarArray

func (*TypedValue) GetProtoBytes

func (x *TypedValue) GetProtoBytes() []byte

func (*TypedValue) GetStringVal

func (x *TypedValue) GetStringVal() string

func (*TypedValue) GetUintVal

func (x *TypedValue) GetUintVal() uint64

func (*TypedValue) GetValue

func (m *TypedValue) GetValue() isTypedValue_Value

func (*TypedValue) ProtoMessage

func (*TypedValue) ProtoMessage()

func (*TypedValue) ProtoReflect

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

func (*TypedValue) Reset

func (x *TypedValue) Reset()

func (*TypedValue) String

func (x *TypedValue) String() string

type TypedValue_AnyVal

type TypedValue_AnyVal struct {
	AnyVal *any.Any `protobuf:"bytes,9,opt,name=any_val,json=anyVal,proto3,oneof"` // protobuf.Any encoded bytes.
}

type TypedValue_AsciiVal

type TypedValue_AsciiVal struct {
	AsciiVal string `protobuf:"bytes,12,opt,name=ascii_val,json=asciiVal,proto3,oneof"` // Arbitrary ASCII text.
}

type TypedValue_BoolVal

type TypedValue_BoolVal struct {
	BoolVal bool `protobuf:"varint,4,opt,name=bool_val,json=boolVal,proto3,oneof"` // Bool value.
}

type TypedValue_BytesVal

type TypedValue_BytesVal struct {
	BytesVal []byte `protobuf:"bytes,5,opt,name=bytes_val,json=bytesVal,proto3,oneof"` // Arbitrary byte sequence value.
}

type TypedValue_DecimalVal

type TypedValue_DecimalVal struct {
	DecimalVal *Decimal64 `protobuf:"bytes,7,opt,name=decimal_val,json=decimalVal,proto3,oneof"` // Decimal64 encoded value.
}

type TypedValue_FloatVal

type TypedValue_FloatVal struct {
	FloatVal float32 `protobuf:"fixed32,6,opt,name=float_val,json=floatVal,proto3,oneof"` // Floating point value.
}

type TypedValue_IntVal

type TypedValue_IntVal struct {
	IntVal int64 `protobuf:"varint,2,opt,name=int_val,json=intVal,proto3,oneof"` // Integer value.
}

type TypedValue_JsonIetfVal

type TypedValue_JsonIetfVal struct {
	JsonIetfVal []byte `protobuf:"bytes,11,opt,name=json_ietf_val,json=jsonIetfVal,proto3,oneof"` // JSON-encoded text per RFC7951.
}

type TypedValue_JsonVal

type TypedValue_JsonVal struct {
	JsonVal []byte `protobuf:"bytes,10,opt,name=json_val,json=jsonVal,proto3,oneof"` // JSON-encoded text.
}

type TypedValue_LeaflistVal

type TypedValue_LeaflistVal struct {
	LeaflistVal *ScalarArray `protobuf:"bytes,8,opt,name=leaflist_val,json=leaflistVal,proto3,oneof"` // Mixed type scalar array value.
}

type TypedValue_ProtoBytes

type TypedValue_ProtoBytes struct {
	// Protobuf binary encoded bytes. The message type is not included.
	// See the specification at
	// github.com/openconfig/reference/blob/master/rpc/gnmi/protobuf-vals.md
	// for a complete specification.
	ProtoBytes []byte `protobuf:"bytes,13,opt,name=proto_bytes,json=protoBytes,proto3,oneof"`
}

type TypedValue_StringVal

type TypedValue_StringVal struct {
	StringVal string `protobuf:"bytes,1,opt,name=string_val,json=stringVal,proto3,oneof"` // String value.
}

type TypedValue_UintVal

type TypedValue_UintVal struct {
	UintVal uint64 `protobuf:"varint,3,opt,name=uint_val,json=uintVal,proto3,oneof"` // Unsigned integer value.
}

type UnimplementedGNMIServer

type UnimplementedGNMIServer struct {
}

UnimplementedGNMIServer can be embedded to have forward compatible implementations.

func (*UnimplementedGNMIServer) Capabilities

func (*UnimplementedGNMIServer) Get

func (*UnimplementedGNMIServer) Set

func (*UnimplementedGNMIServer) Subscribe

type Update

type Update struct {
	Path *Path `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // The path (key) for the update.
	// Deprecated: Do not use.
	Value      *Value      `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`            // The value (value) for the update.
	Val        *TypedValue `protobuf:"bytes,3,opt,name=val,proto3" json:"val,omitempty"`                // The explicitly typed update value.
	Duplicates uint32      `protobuf:"varint,4,opt,name=duplicates,proto3" json:"duplicates,omitempty"` // Number of coalesced duplicates.
	// contains filtered or unexported fields
}

Update is a re-usable message that is used to store a particular Path, Value pair. Reference: gNMI Specification Section 2.1

func (*Update) Descriptor deprecated

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

Deprecated: Use Update.ProtoReflect.Descriptor instead.

func (*Update) GetDuplicates

func (x *Update) GetDuplicates() uint32

func (*Update) GetPath

func (x *Update) GetPath() *Path

func (*Update) GetVal

func (x *Update) GetVal() *TypedValue

func (*Update) GetValue deprecated

func (x *Update) GetValue() *Value

Deprecated: Do not use.

func (*Update) ProtoMessage

func (*Update) ProtoMessage()

func (*Update) ProtoReflect

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

func (*Update) Reset

func (x *Update) Reset()

func (*Update) String

func (x *Update) String() string

type UpdateResult

type UpdateResult struct {

	// Deprecated timestamp for the UpdateResult, this field has been
	// replaced by the timestamp within the SetResponse message, since
	// all mutations effected by a set should be applied as a single
	// transaction.
	//
	// Deprecated: Do not use.
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Path      *Path `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // Path associated with the update.
	// Deprecated: Do not use.
	Message *Error                 `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`                         // Status of the update operation.
	Op      UpdateResult_Operation `protobuf:"varint,4,opt,name=op,proto3,enum=gnmi.UpdateResult_Operation" json:"op,omitempty"` // Update operation type.
	// contains filtered or unexported fields
}

UpdateResult is used within the SetResponse message to communicate the result of an operation specified within a SetRequest message. Reference: gNMI Specification Section 3.4.2

func (*UpdateResult) Descriptor deprecated

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

Deprecated: Use UpdateResult.ProtoReflect.Descriptor instead.

func (*UpdateResult) GetMessage deprecated

func (x *UpdateResult) GetMessage() *Error

Deprecated: Do not use.

func (*UpdateResult) GetOp

func (*UpdateResult) GetPath

func (x *UpdateResult) GetPath() *Path

func (*UpdateResult) GetTimestamp deprecated

func (x *UpdateResult) GetTimestamp() int64

Deprecated: Do not use.

func (*UpdateResult) ProtoMessage

func (*UpdateResult) ProtoMessage()

func (*UpdateResult) ProtoReflect

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

func (*UpdateResult) Reset

func (x *UpdateResult) Reset()

func (*UpdateResult) String

func (x *UpdateResult) String() string

type UpdateResult_Operation

type UpdateResult_Operation int32

The operation that was associated with the Path specified.

const (
	UpdateResult_INVALID UpdateResult_Operation = 0
	UpdateResult_DELETE  UpdateResult_Operation = 1 // The result relates to a delete of Path.
	UpdateResult_REPLACE UpdateResult_Operation = 2 // The result relates to a replace of Path.
	UpdateResult_UPDATE  UpdateResult_Operation = 3 // The result relates to an update of Path.
)

func (UpdateResult_Operation) Descriptor

func (UpdateResult_Operation) Enum

func (UpdateResult_Operation) EnumDescriptor deprecated

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

Deprecated: Use UpdateResult_Operation.Descriptor instead.

func (UpdateResult_Operation) Number

func (UpdateResult_Operation) String

func (x UpdateResult_Operation) String() string

func (UpdateResult_Operation) Type

type Value deprecated

type Value struct {
	Value []byte   `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`                   // Value of the variable being transmitted.
	Type  Encoding `protobuf:"varint,2,opt,name=type,proto3,enum=gnmi.Encoding" json:"type,omitempty"` // Encoding used for the value field.
	// contains filtered or unexported fields
}

Value encodes a data tree node's value - along with the way in which the value is encoded. This message is deprecated by gNMI 0.3.0. Reference: gNMI Specification Section 2.2.3.

Deprecated: Do not use.

func (*Value) Descriptor deprecated

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

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetType

func (x *Value) GetType() Encoding

func (*Value) GetValue

func (x *Value) GetValue() []byte

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) ProtoReflect

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

func (*Value) Reset

func (x *Value) Reset()

func (*Value) String

func (x *Value) String() string

Source Files

Jump to

Keyboard shortcuts

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