Documentation ¶
Index ¶
- Variables
- type Extension
- func (*Extension) Descriptor() ([]byte, []int)deprecated
- func (m *Extension) GetExt() isExtension_Ext
- func (x *Extension) GetMasterArbitration() *MasterArbitration
- func (x *Extension) GetRegisteredExt() *RegisteredExtension
- func (*Extension) ProtoMessage()
- func (x *Extension) ProtoReflect() protoreflect.Message
- func (x *Extension) Reset()
- func (x *Extension) String() string
- type ExtensionID
- func (ExtensionID) Descriptor() protoreflect.EnumDescriptor
- func (x ExtensionID) Enum() *ExtensionID
- func (ExtensionID) EnumDescriptor() ([]byte, []int)deprecated
- func (x ExtensionID) Number() protoreflect.EnumNumber
- func (x ExtensionID) String() string
- func (ExtensionID) Type() protoreflect.EnumType
- type Extension_MasterArbitration
- type Extension_RegisteredExt
- type MasterArbitration
- func (*MasterArbitration) Descriptor() ([]byte, []int)deprecated
- func (x *MasterArbitration) GetElectionId() *Uint128
- func (x *MasterArbitration) GetRole() *Role
- func (*MasterArbitration) ProtoMessage()
- func (x *MasterArbitration) ProtoReflect() protoreflect.Message
- func (x *MasterArbitration) Reset()
- func (x *MasterArbitration) String() string
- type RegisteredExtension
- func (*RegisteredExtension) Descriptor() ([]byte, []int)deprecated
- func (x *RegisteredExtension) GetId() ExtensionID
- func (x *RegisteredExtension) GetMsg() []byte
- func (*RegisteredExtension) ProtoMessage()
- func (x *RegisteredExtension) ProtoReflect() protoreflect.Message
- func (x *RegisteredExtension) Reset()
- func (x *RegisteredExtension) String() string
- type Role
- type Uint128
Constants ¶
This section is empty.
Variables ¶
var ( ExtensionID_name = map[int32]string{ 0: "EID_UNSET", 999: "EID_EXPERIMENTAL", } ExtensionID_value = map[string]int32{ "EID_UNSET": 0, "EID_EXPERIMENTAL": 999, } )
Enum value maps for ExtensionID.
var File_proto_gnmi_ext_gnmi_ext_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Extension ¶
type Extension struct { // Types that are assignable to Ext: // *Extension_RegisteredExt // *Extension_MasterArbitration Ext isExtension_Ext `protobuf_oneof:"ext"` // contains filtered or unexported fields }
The Extension message contains a single gNMI extension.
func (*Extension) Descriptor
deprecated
func (*Extension) GetMasterArbitration ¶
func (x *Extension) GetMasterArbitration() *MasterArbitration
func (*Extension) GetRegisteredExt ¶
func (x *Extension) GetRegisteredExt() *RegisteredExtension
func (*Extension) ProtoMessage ¶
func (*Extension) ProtoMessage()
func (*Extension) ProtoReflect ¶
func (x *Extension) ProtoReflect() protoreflect.Message
type ExtensionID ¶
type ExtensionID int32
RegisteredExtension is an enumeration acting as a registry for extensions defined by external sources.
const ( ExtensionID_EID_UNSET ExtensionID = 0 // An experimental extension that may be used during prototyping of a new // extension. ExtensionID_EID_EXPERIMENTAL ExtensionID = 999 )
func (ExtensionID) Descriptor ¶
func (ExtensionID) Descriptor() protoreflect.EnumDescriptor
func (ExtensionID) Enum ¶
func (x ExtensionID) Enum() *ExtensionID
func (ExtensionID) EnumDescriptor
deprecated
func (ExtensionID) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExtensionID.Descriptor instead.
func (ExtensionID) Number ¶
func (x ExtensionID) Number() protoreflect.EnumNumber
func (ExtensionID) String ¶
func (x ExtensionID) String() string
func (ExtensionID) Type ¶
func (ExtensionID) Type() protoreflect.EnumType
type Extension_MasterArbitration ¶
type Extension_MasterArbitration struct { // Well known extensions. MasterArbitration *MasterArbitration `protobuf:"bytes,2,opt,name=master_arbitration,json=masterArbitration,proto3,oneof"` // Master arbitration extension. }
type Extension_RegisteredExt ¶
type Extension_RegisteredExt struct {
RegisteredExt *RegisteredExtension `protobuf:"bytes,1,opt,name=registered_ext,json=registeredExt,proto3,oneof"` // A registered extension.
}
type MasterArbitration ¶
type MasterArbitration struct { Role *Role `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"` ElectionId *Uint128 `protobuf:"bytes,2,opt,name=election_id,json=electionId,proto3" json:"election_id,omitempty"` // contains filtered or unexported fields }
MasterArbitration is used to select the master among multiple gNMI clients with the same Roles. The client with the largest election_id is honored as the master. The document about gNMI master arbitration can be found at https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-master-arbitration.md
func (*MasterArbitration) Descriptor
deprecated
func (*MasterArbitration) Descriptor() ([]byte, []int)
Deprecated: Use MasterArbitration.ProtoReflect.Descriptor instead.
func (*MasterArbitration) GetElectionId ¶
func (x *MasterArbitration) GetElectionId() *Uint128
func (*MasterArbitration) GetRole ¶
func (x *MasterArbitration) GetRole() *Role
func (*MasterArbitration) ProtoMessage ¶
func (*MasterArbitration) ProtoMessage()
func (*MasterArbitration) ProtoReflect ¶
func (x *MasterArbitration) ProtoReflect() protoreflect.Message
func (*MasterArbitration) Reset ¶
func (x *MasterArbitration) Reset()
func (*MasterArbitration) String ¶
func (x *MasterArbitration) String() string
type RegisteredExtension ¶
type RegisteredExtension struct { Id ExtensionID `protobuf:"varint,1,opt,name=id,proto3,enum=gnmi_ext.ExtensionID" json:"id,omitempty"` // The unique ID assigned to this extension. Msg []byte `protobuf:"bytes,2,opt,name=msg,proto3" json:"msg,omitempty"` // The binary-marshalled protobuf extension payload. // contains filtered or unexported fields }
The RegisteredExtension message defines an extension which is defined outside of this file.
func (*RegisteredExtension) Descriptor
deprecated
func (*RegisteredExtension) Descriptor() ([]byte, []int)
Deprecated: Use RegisteredExtension.ProtoReflect.Descriptor instead.
func (*RegisteredExtension) GetId ¶
func (x *RegisteredExtension) GetId() ExtensionID
func (*RegisteredExtension) GetMsg ¶
func (x *RegisteredExtension) GetMsg() []byte
func (*RegisteredExtension) ProtoMessage ¶
func (*RegisteredExtension) ProtoMessage()
func (*RegisteredExtension) ProtoReflect ¶
func (x *RegisteredExtension) ProtoReflect() protoreflect.Message
func (*RegisteredExtension) Reset ¶
func (x *RegisteredExtension) Reset()
func (*RegisteredExtension) String ¶
func (x *RegisteredExtension) String() string
type Role ¶
type Role struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
There can be one master for each role. The role is identified by its id.
func (*Role) Descriptor
deprecated
func (*Role) ProtoMessage ¶
func (*Role) ProtoMessage()
func (*Role) ProtoReflect ¶
func (x *Role) ProtoReflect() protoreflect.Message
type Uint128 ¶
type Uint128 struct { High uint64 `protobuf:"varint,1,opt,name=high,proto3" json:"high,omitempty"` Low uint64 `protobuf:"varint,2,opt,name=low,proto3" json:"low,omitempty"` // contains filtered or unexported fields }
Representation of unsigned 128-bit integer.
func (*Uint128) Descriptor
deprecated
func (*Uint128) ProtoMessage ¶
func (*Uint128) ProtoMessage()
func (*Uint128) ProtoReflect ¶
func (x *Uint128) ProtoReflect() protoreflect.Message