gnmi

package
v0.13.0 Latest Latest
Warning

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

Go to latest
Published: Jan 29, 2025 License: Apache-2.0 Imports: 11 Imported by: 754

Documentation

Index

Constants

View Source
const (
	GNMI_Capabilities_FullMethodName = "/gnmi.gNMI/Capabilities"
	GNMI_Get_FullMethodName          = "/gnmi.gNMI/Get"
	GNMI_Set_FullMethodName          = "/gnmi.gNMI/Set"
	GNMI_Subscribe_FullMethodName    = "/gnmi.gNMI/Subscribe"
)

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",
		4: "UNION_REPLACE",
	}
	UpdateResult_Operation_value = map[string]int32{
		"INVALID":       0,
		"DELETE":        1,
		"REPLACE":       2,
		"UPDATE":        3,
		"UNION_REPLACE": 4,
	}
)

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 (
	// optional string gnmi_service = 1001;
	E_GnmiService = &file_github_com_openconfig_gnmi_proto_gnmi_gnmi_proto_extTypes[0]
)

Extension fields to descriptorpb.FileOptions.

View Source
var File_github_com_openconfig_gnmi_proto_gnmi_gnmi_proto protoreflect.FileDescriptor
View Source
var GNMI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "gnmi.gNMI",
	HandlerType: (*GNMIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Capabilities",
			Handler:    _GNMI_Capabilities_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _GNMI_Get_Handler,
		},
		{
			MethodName: "Set",
			Handler:    _GNMI_Set_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Subscribe",
			Handler:       _GNMI_Subscribe_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "github.com/openconfig/gnmi/proto/gnmi/gnmi.proto",
}

GNMI_ServiceDesc is the grpc.ServiceDesc for GNMI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterGNMIServer

func RegisterGNMIServer(s grpc.ServiceRegistrar, srv GNMIServer)

Types

type CapabilityRequest

type CapabilityRequest struct {
	Extension []*gnmi_ext.Extension `protobuf:"bytes,1,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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"`
	SupportedEncodings []Encoding            `` /* 142-byte string literal not displayed */
	GNMIVersion        string                `protobuf:"bytes,3,opt,name=gNMI_version,json=gNMIVersion,proto3" json:"gNMI_version,omitempty"`
	Extension          []*gnmi_ext.Extension `protobuf:"bytes,4,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated

type Decimal64 struct {
	Digits    int64  `protobuf:"varint,1,opt,name=digits,proto3" json:"digits,omitempty"`
	Precision uint32 `protobuf:"varint,2,opt,name=precision,proto3" json:"precision,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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
const (
	Encoding_JSON      Encoding = 0
	Encoding_BYTES     Encoding = 1
	Encoding_PROTO     Encoding = 2
	Encoding_ASCII     Encoding = 3
	Encoding_JSON_IETF Encoding = 4
)

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"`
	Message string     `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	Data    *anypb.Any `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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() *anypb.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(ctx context.Context, in *CapabilityRequest, opts ...grpc.CallOption) (*CapabilityResponse, error)
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	Set(ctx context.Context, in *SetRequest, opts ...grpc.CallOption) (*SetResponse, error)
	Subscribe(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[SubscribeRequest, SubscribeResponse], error)
}

GNMIClient is the client API for GNMI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewGNMIClient

func NewGNMIClient(cc grpc.ClientConnInterface) GNMIClient

type GNMIServer

GNMIServer is the server API for GNMI service. All implementations should embed UnimplementedGNMIServer for forward compatibility.

type GNMI_SubscribeClient

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type GNMI_SubscribeServer

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type GetRequest

type GetRequest struct {
	Prefix    *Path                 `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
	Path      []*Path               `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"`
	Type      GetRequest_DataType   `protobuf:"varint,3,opt,name=type,proto3,enum=gnmi.GetRequest_DataType" json:"type,omitempty"`
	Encoding  Encoding              `protobuf:"varint,5,opt,name=encoding,proto3,enum=gnmi.Encoding" json:"encoding,omitempty"`
	UseModels []*ModelData          `protobuf:"bytes,6,rep,name=use_models,json=useModels,proto3" json:"use_models,omitempty"`
	Extension []*gnmi_ext.Extension `protobuf:"bytes,7,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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
const (
	GetRequest_ALL         GetRequest_DataType = 0
	GetRequest_CONFIG      GetRequest_DataType = 1
	GetRequest_STATE       GetRequest_DataType = 2
	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"`
	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Error     *Error                `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	Extension []*gnmi_ext.Extension `protobuf:"bytes,3,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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"`
	Organization string `protobuf:"bytes,2,opt,name=organization,proto3" json:"organization,omitempty"`
	Version      string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

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"`
	Prefix    *Path     `protobuf:"bytes,2,opt,name=prefix,proto3" json:"prefix,omitempty"`
	Update    []*Update `protobuf:"bytes,4,rep,name=update,proto3" json:"update,omitempty"`
	Delete    []*Path   `protobuf:"bytes,5,rep,name=delete,proto3" json:"delete,omitempty"`
	Atomic    bool      `protobuf:"varint,6,opt,name=atomic,proto3" json:"atomic,omitempty"`
	// contains filtered or unexported fields
}

func (*Notification) Descriptor deprecated

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

Deprecated: Use Notification.ProtoReflect.Descriptor instead.

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 {

	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Element []string    `protobuf:"bytes,1,rep,name=element,proto3" json:"element,omitempty"`
	Origin  string      `protobuf:"bytes,2,opt,name=origin,proto3" json:"origin,omitempty"`
	Elem    []*PathElem `protobuf:"bytes,3,rep,name=elem,proto3" json:"elem,omitempty"`
	Target  string      `protobuf:"bytes,4,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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"`
	Key  map[string]string `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

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
}

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
}

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 {
	Element []*TypedValue `protobuf:"bytes,1,rep,name=element,proto3" json:"element,omitempty"`
	// contains filtered or unexported fields
}

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"`
	Delete       []*Path               `protobuf:"bytes,2,rep,name=delete,proto3" json:"delete,omitempty"`
	Replace      []*Update             `protobuf:"bytes,3,rep,name=replace,proto3" json:"replace,omitempty"`
	Update       []*Update             `protobuf:"bytes,4,rep,name=update,proto3" json:"update,omitempty"`
	UnionReplace []*Update             `protobuf:"bytes,6,rep,name=union_replace,json=unionReplace,proto3" json:"union_replace,omitempty"`
	Extension    []*gnmi_ext.Extension `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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) GetUnionReplace added in v0.10.0

func (x *SetRequest) GetUnionReplace() []*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"`
	Response []*UpdateResult `protobuf:"bytes,2,rep,name=response,proto3" json:"response,omitempty"`
	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Message   *Error                `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	Timestamp int64                 `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Extension []*gnmi_ext.Extension `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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 valid to be assigned to Request:
	//
	//	*SubscribeRequest_Subscribe
	//	*SubscribeRequest_Poll
	Request   isSubscribeRequest_Request `protobuf_oneof:"request"`
	Extension []*gnmi_ext.Extension      `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeRequest) Descriptor deprecated

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

Deprecated: Use SubscribeRequest.ProtoReflect.Descriptor instead.

func (*SubscribeRequest) GetExtension

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

func (*SubscribeRequest) GetPoll

func (x *SubscribeRequest) GetPoll() *Poll

func (*SubscribeRequest) GetRequest

func (x *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_Poll

type SubscribeRequest_Poll struct {
	Poll *Poll `protobuf:"bytes,3,opt,name=poll,proto3,oneof"`
}

type SubscribeRequest_Subscribe

type SubscribeRequest_Subscribe struct {
	Subscribe *SubscriptionList `protobuf:"bytes,1,opt,name=subscribe,proto3,oneof"`
}

type SubscribeResponse

type SubscribeResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*SubscribeResponse_Update
	//	*SubscribeResponse_SyncResponse
	//	*SubscribeResponse_Error
	Response  isSubscribeResponse_Response `protobuf_oneof:"response"`
	Extension []*gnmi_ext.Extension        `protobuf:"bytes,5,rep,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

func (*SubscribeResponse) GetExtension

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

func (*SubscribeResponse) GetResponse

func (x *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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Error *Error `protobuf:"bytes,4,opt,name=error,proto3,oneof"`
}

type SubscribeResponse_SyncResponse

type SubscribeResponse_SyncResponse struct {
	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"`
}

type Subscription

type Subscription struct {
	Path              *Path            `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	Mode              SubscriptionMode `protobuf:"varint,2,opt,name=mode,proto3,enum=gnmi.SubscriptionMode" json:"mode,omitempty"`
	SampleInterval    uint64           `protobuf:"varint,3,opt,name=sample_interval,json=sampleInterval,proto3" json:"sample_interval,omitempty"`
	SuppressRedundant bool             `protobuf:"varint,4,opt,name=suppress_redundant,json=suppressRedundant,proto3" json:"suppress_redundant,omitempty"`
	HeartbeatInterval uint64           `protobuf:"varint,5,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"`
	// contains filtered or unexported fields
}

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"`
	Subscription     []*Subscription       `protobuf:"bytes,2,rep,name=subscription,proto3" json:"subscription,omitempty"`
	Qos              *QOSMarking           `protobuf:"bytes,4,opt,name=qos,proto3" json:"qos,omitempty"`
	Mode             SubscriptionList_Mode `protobuf:"varint,5,opt,name=mode,proto3,enum=gnmi.SubscriptionList_Mode" json:"mode,omitempty"`
	AllowAggregation bool                  `protobuf:"varint,6,opt,name=allow_aggregation,json=allowAggregation,proto3" json:"allow_aggregation,omitempty"`
	UseModels        []*ModelData          `protobuf:"bytes,7,rep,name=use_models,json=useModels,proto3" json:"use_models,omitempty"`
	Encoding         Encoding              `protobuf:"varint,8,opt,name=encoding,proto3,enum=gnmi.Encoding" json:"encoding,omitempty"`
	UpdatesOnly      bool                  `protobuf:"varint,9,opt,name=updates_only,json=updatesOnly,proto3" json:"updates_only,omitempty"`
	// contains filtered or unexported fields
}

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) 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
const (
	SubscriptionList_STREAM SubscriptionList_Mode = 0
	SubscriptionList_ONCE   SubscriptionList_Mode = 1
	SubscriptionList_POLL   SubscriptionList_Mode = 2
)

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
const (
	SubscriptionMode_TARGET_DEFINED SubscriptionMode = 0
	SubscriptionMode_ON_CHANGE      SubscriptionMode = 1
	SubscriptionMode_SAMPLE         SubscriptionMode = 2
)

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 {

	// Types that are valid to be assigned to Value:
	//
	//	*TypedValue_StringVal
	//	*TypedValue_IntVal
	//	*TypedValue_UintVal
	//	*TypedValue_BoolVal
	//	*TypedValue_BytesVal
	//	*TypedValue_FloatVal
	//	*TypedValue_DoubleVal
	//	*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
}

func (*TypedValue) Descriptor deprecated

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

Deprecated: Use TypedValue.ProtoReflect.Descriptor instead.

func (*TypedValue) GetAnyVal

func (x *TypedValue) GetAnyVal() *anypb.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 deprecated

func (x *TypedValue) GetDecimalVal() *Decimal64

Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

func (*TypedValue) GetDoubleVal

func (x *TypedValue) GetDoubleVal() float64

func (*TypedValue) GetFloatVal deprecated

func (x *TypedValue) GetFloatVal() float32

Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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 (x *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 *anypb.Any `protobuf:"bytes,9,opt,name=any_val,json=anyVal,proto3,oneof"`
}

type TypedValue_AsciiVal

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

type TypedValue_BoolVal

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

type TypedValue_BytesVal

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

type TypedValue_DecimalVal

type TypedValue_DecimalVal struct {
	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	DecimalVal *Decimal64 `protobuf:"bytes,7,opt,name=decimal_val,json=decimalVal,proto3,oneof"`
}

type TypedValue_DoubleVal

type TypedValue_DoubleVal struct {
	DoubleVal float64 `protobuf:"fixed64,14,opt,name=double_val,json=doubleVal,proto3,oneof"`
}

type TypedValue_FloatVal

type TypedValue_FloatVal struct {
	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	FloatVal float32 `protobuf:"fixed32,6,opt,name=float_val,json=floatVal,proto3,oneof"`
}

type TypedValue_IntVal

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

type TypedValue_JsonIetfVal

type TypedValue_JsonIetfVal struct {
	JsonIetfVal []byte `protobuf:"bytes,11,opt,name=json_ietf_val,json=jsonIetfVal,proto3,oneof"`
}

type TypedValue_JsonVal

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

type TypedValue_LeaflistVal

type TypedValue_LeaflistVal struct {
	LeaflistVal *ScalarArray `protobuf:"bytes,8,opt,name=leaflist_val,json=leaflistVal,proto3,oneof"`
}

type TypedValue_ProtoBytes

type TypedValue_ProtoBytes struct {
	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"`
}

type TypedValue_UintVal

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

type UnimplementedGNMIServer

type UnimplementedGNMIServer struct{}

UnimplementedGNMIServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedGNMIServer) Capabilities

func (UnimplementedGNMIServer) Get

func (UnimplementedGNMIServer) Set

type UnsafeGNMIServer

type UnsafeGNMIServer interface {
	// contains filtered or unexported methods
}

UnsafeGNMIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to GNMIServer will result in compilation errors.

type Update

type Update struct {
	Path *Path `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Value      *Value      `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	Val        *TypedValue `protobuf:"bytes,3,opt,name=val,proto3" json:"val,omitempty"`
	Duplicates uint32      `protobuf:"varint,4,opt,name=duplicates,proto3" json:"duplicates,omitempty"`
	// contains filtered or unexported fields
}

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Path      *Path `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.
	Message *Error                 `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	Op      UpdateResult_Operation `protobuf:"varint,4,opt,name=op,proto3,enum=gnmi.UpdateResult_Operation" json:"op,omitempty"`
	// contains filtered or unexported fields
}

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: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

func (*UpdateResult) GetOp

func (*UpdateResult) GetPath

func (x *UpdateResult) GetPath() *Path

func (*UpdateResult) GetTimestamp deprecated

func (x *UpdateResult) GetTimestamp() int64

Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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
const (
	UpdateResult_INVALID       UpdateResult_Operation = 0
	UpdateResult_DELETE        UpdateResult_Operation = 1
	UpdateResult_REPLACE       UpdateResult_Operation = 2
	UpdateResult_UPDATE        UpdateResult_Operation = 3
	UpdateResult_UNION_REPLACE UpdateResult_Operation = 4
)

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"`
	Type  Encoding `protobuf:"varint,2,opt,name=type,proto3,enum=gnmi.Encoding" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Marked as deprecated in github.com/openconfig/gnmi/proto/gnmi/gnmi.proto.

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

Jump to

Keyboard shortcuts

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