Documentation ¶
Overview ¶
Package voltha is a generated protocol buffer package.
It is generated from these files:
events.proto
It has these top-level messages:
ConfigEventType ConfigEvent KpiEventType MetricValuePairs KpiEvent AlarmEventType AlarmEventCategory AlarmEventState AlarmEventSeverity AlarmEvent
Index ¶
- Variables
- type AlarmEvent
- func (*AlarmEvent) Descriptor() ([]byte, []int)
- func (m *AlarmEvent) GetCategory() AlarmEventCategory_AlarmEventCategory
- func (m *AlarmEvent) GetChangedTs() float32
- func (m *AlarmEvent) GetContext() map[string]string
- func (m *AlarmEvent) GetDescription() string
- func (m *AlarmEvent) GetId() string
- func (m *AlarmEvent) GetRaisedTs() float32
- func (m *AlarmEvent) GetReportedTs() float32
- func (m *AlarmEvent) GetResourceId() string
- func (m *AlarmEvent) GetSeverity() AlarmEventSeverity_AlarmEventSeverity
- func (m *AlarmEvent) GetState() AlarmEventState_AlarmEventState
- func (m *AlarmEvent) GetType() AlarmEventType_AlarmEventType
- func (*AlarmEvent) ProtoMessage()
- func (m *AlarmEvent) Reset()
- func (m *AlarmEvent) String() string
- type AlarmEventCategory
- type AlarmEventCategory_AlarmEventCategory
- type AlarmEventSeverity
- type AlarmEventSeverity_AlarmEventSeverity
- type AlarmEventState
- type AlarmEventState_AlarmEventState
- type AlarmEventType
- type AlarmEventType_AlarmEventType
- type ConfigEvent
- type ConfigEventType
- type ConfigEventType_ConfigEventType
- type KpiEvent
- type KpiEventType
- type KpiEventType_KpiEventType
- type MetricValuePairs
Constants ¶
This section is empty.
Variables ¶
View Source
var AlarmEventCategory_AlarmEventCategory_name = map[int32]string{
0: "PON",
}
View Source
var AlarmEventCategory_AlarmEventCategory_value = map[string]int32{
"PON": 0,
}
View Source
var AlarmEventSeverity_AlarmEventSeverity_name = map[int32]string{
0: "INDETERMINATE",
1: "WARNING",
2: "MINOR",
3: "MAJOR",
4: "CRITICAL",
}
View Source
var AlarmEventSeverity_AlarmEventSeverity_value = map[string]int32{
"INDETERMINATE": 0,
"WARNING": 1,
"MINOR": 2,
"MAJOR": 3,
"CRITICAL": 4,
}
View Source
var AlarmEventState_AlarmEventState_name = map[int32]string{
0: "RAISED",
1: "CLEARED",
}
View Source
var AlarmEventState_AlarmEventState_value = map[string]int32{
"RAISED": 0,
"CLEARED": 1,
}
View Source
var AlarmEventType_AlarmEventType_name = map[int32]string{
0: "COMMUNICATION",
1: "ENVIRONMENT",
2: "EQUIPMENT",
3: "SERVICE",
4: "PROCESSING",
5: "SECURITY",
}
View Source
var AlarmEventType_AlarmEventType_value = map[string]int32{
"COMMUNICATION": 0,
"ENVIRONMENT": 1,
"EQUIPMENT": 2,
"SERVICE": 3,
"PROCESSING": 4,
"SECURITY": 5,
}
View Source
var ConfigEventType_ConfigEventType_name = map[int32]string{
0: "add",
1: "remove",
2: "update",
}
View Source
var ConfigEventType_ConfigEventType_value = map[string]int32{
"add": 0,
"remove": 1,
"update": 2,
}
View Source
var KpiEventType_KpiEventType_name = map[int32]string{
0: "slice",
1: "ts",
}
View Source
var KpiEventType_KpiEventType_value = map[string]int32{
"slice": 0,
"ts": 1,
}
Functions ¶
This section is empty.
Types ¶
type AlarmEvent ¶
type AlarmEvent struct { // Unique ID for this alarm. e.g. voltha.some_olt.1234 Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // Refers to the area of the system impacted by the alarm Type AlarmEventType_AlarmEventType `protobuf:"varint,2,opt,name=type,enum=voltha.AlarmEventType_AlarmEventType" json:"type,omitempty"` // Refers to functional category of the alarm Category AlarmEventCategory_AlarmEventCategory `protobuf:"varint,3,opt,name=category,enum=voltha.AlarmEventCategory_AlarmEventCategory" json:"category,omitempty"` // Current active state of the alarm State AlarmEventState_AlarmEventState `protobuf:"varint,4,opt,name=state,enum=voltha.AlarmEventState_AlarmEventState" json:"state,omitempty"` // Overall impact of the alarm on the system Severity AlarmEventSeverity_AlarmEventSeverity `protobuf:"varint,5,opt,name=severity,enum=voltha.AlarmEventSeverity_AlarmEventSeverity" json:"severity,omitempty"` // Timestamp at which the alarm was first raised RaisedTs float32 `protobuf:"fixed32,6,opt,name=raised_ts,json=raisedTs" json:"raised_ts,omitempty"` // Timestamp at which the alarm was reported ReportedTs float32 `protobuf:"fixed32,7,opt,name=reported_ts,json=reportedTs" json:"reported_ts,omitempty"` // Timestamp at which the alarm has changed since it was raised ChangedTs float32 `protobuf:"fixed32,8,opt,name=changed_ts,json=changedTs" json:"changed_ts,omitempty"` // Identifier of the originating resource of the alarm ResourceId string `protobuf:"bytes,9,opt,name=resource_id,json=resourceId" json:"resource_id,omitempty"` // Textual explanation of the alarm Description string `protobuf:"bytes,10,opt,name=description" json:"description,omitempty"` // Key/Value storage for extra information that may give context to the alarm Context map[string]string `` /* 135-byte string literal not displayed */ }
func (*AlarmEvent) Descriptor ¶
func (*AlarmEvent) Descriptor() ([]byte, []int)
func (*AlarmEvent) GetCategory ¶
func (m *AlarmEvent) GetCategory() AlarmEventCategory_AlarmEventCategory
func (*AlarmEvent) GetChangedTs ¶
func (m *AlarmEvent) GetChangedTs() float32
func (*AlarmEvent) GetContext ¶
func (m *AlarmEvent) GetContext() map[string]string
func (*AlarmEvent) GetDescription ¶
func (m *AlarmEvent) GetDescription() string
func (*AlarmEvent) GetId ¶
func (m *AlarmEvent) GetId() string
func (*AlarmEvent) GetRaisedTs ¶
func (m *AlarmEvent) GetRaisedTs() float32
func (*AlarmEvent) GetReportedTs ¶
func (m *AlarmEvent) GetReportedTs() float32
func (*AlarmEvent) GetResourceId ¶
func (m *AlarmEvent) GetResourceId() string
func (*AlarmEvent) GetSeverity ¶
func (m *AlarmEvent) GetSeverity() AlarmEventSeverity_AlarmEventSeverity
func (*AlarmEvent) GetState ¶
func (m *AlarmEvent) GetState() AlarmEventState_AlarmEventState
func (*AlarmEvent) GetType ¶
func (m *AlarmEvent) GetType() AlarmEventType_AlarmEventType
func (*AlarmEvent) ProtoMessage ¶
func (*AlarmEvent) ProtoMessage()
func (*AlarmEvent) Reset ¶
func (m *AlarmEvent) Reset()
func (*AlarmEvent) String ¶
func (m *AlarmEvent) String() string
type AlarmEventCategory ¶
type AlarmEventCategory struct { }
Identify to the functional category originating the alarm
func (*AlarmEventCategory) Descriptor ¶
func (*AlarmEventCategory) Descriptor() ([]byte, []int)
func (*AlarmEventCategory) ProtoMessage ¶
func (*AlarmEventCategory) ProtoMessage()
func (*AlarmEventCategory) Reset ¶
func (m *AlarmEventCategory) Reset()
func (*AlarmEventCategory) String ¶
func (m *AlarmEventCategory) String() string
type AlarmEventCategory_AlarmEventCategory ¶
type AlarmEventCategory_AlarmEventCategory int32
const (
AlarmEventCategory_PON AlarmEventCategory_AlarmEventCategory = 0
)
func (AlarmEventCategory_AlarmEventCategory) EnumDescriptor ¶
func (AlarmEventCategory_AlarmEventCategory) EnumDescriptor() ([]byte, []int)
func (AlarmEventCategory_AlarmEventCategory) String ¶
func (x AlarmEventCategory_AlarmEventCategory) String() string
type AlarmEventSeverity ¶
type AlarmEventSeverity struct { }
Identify the overall impact of the alarm on the system
func (*AlarmEventSeverity) Descriptor ¶
func (*AlarmEventSeverity) Descriptor() ([]byte, []int)
func (*AlarmEventSeverity) ProtoMessage ¶
func (*AlarmEventSeverity) ProtoMessage()
func (*AlarmEventSeverity) Reset ¶
func (m *AlarmEventSeverity) Reset()
func (*AlarmEventSeverity) String ¶
func (m *AlarmEventSeverity) String() string
type AlarmEventSeverity_AlarmEventSeverity ¶
type AlarmEventSeverity_AlarmEventSeverity int32
const ( AlarmEventSeverity_INDETERMINATE AlarmEventSeverity_AlarmEventSeverity = 0 AlarmEventSeverity_WARNING AlarmEventSeverity_AlarmEventSeverity = 1 AlarmEventSeverity_MINOR AlarmEventSeverity_AlarmEventSeverity = 2 AlarmEventSeverity_MAJOR AlarmEventSeverity_AlarmEventSeverity = 3 AlarmEventSeverity_CRITICAL AlarmEventSeverity_AlarmEventSeverity = 4 )
func (AlarmEventSeverity_AlarmEventSeverity) EnumDescriptor ¶
func (AlarmEventSeverity_AlarmEventSeverity) EnumDescriptor() ([]byte, []int)
func (AlarmEventSeverity_AlarmEventSeverity) String ¶
func (x AlarmEventSeverity_AlarmEventSeverity) String() string
type AlarmEventState ¶
type AlarmEventState struct { }
Active state of the alarm
func (*AlarmEventState) Descriptor ¶
func (*AlarmEventState) Descriptor() ([]byte, []int)
func (*AlarmEventState) ProtoMessage ¶
func (*AlarmEventState) ProtoMessage()
func (*AlarmEventState) Reset ¶
func (m *AlarmEventState) Reset()
func (*AlarmEventState) String ¶
func (m *AlarmEventState) String() string
type AlarmEventState_AlarmEventState ¶
type AlarmEventState_AlarmEventState int32
const ( AlarmEventState_RAISED AlarmEventState_AlarmEventState = 0 AlarmEventState_CLEARED AlarmEventState_AlarmEventState = 1 )
func (AlarmEventState_AlarmEventState) EnumDescriptor ¶
func (AlarmEventState_AlarmEventState) EnumDescriptor() ([]byte, []int)
func (AlarmEventState_AlarmEventState) String ¶
func (x AlarmEventState_AlarmEventState) String() string
type AlarmEventType ¶
type AlarmEventType struct { }
Identify to the area of the system impacted by the alarm
func (*AlarmEventType) Descriptor ¶
func (*AlarmEventType) Descriptor() ([]byte, []int)
func (*AlarmEventType) ProtoMessage ¶
func (*AlarmEventType) ProtoMessage()
func (*AlarmEventType) Reset ¶
func (m *AlarmEventType) Reset()
func (*AlarmEventType) String ¶
func (m *AlarmEventType) String() string
type AlarmEventType_AlarmEventType ¶
type AlarmEventType_AlarmEventType int32
const ( AlarmEventType_COMMUNICATION AlarmEventType_AlarmEventType = 0 AlarmEventType_ENVIRONMENT AlarmEventType_AlarmEventType = 1 AlarmEventType_EQUIPMENT AlarmEventType_AlarmEventType = 2 AlarmEventType_SERVICE AlarmEventType_AlarmEventType = 3 AlarmEventType_PROCESSING AlarmEventType_AlarmEventType = 4 AlarmEventType_SECURITY AlarmEventType_AlarmEventType = 5 )
func (AlarmEventType_AlarmEventType) EnumDescriptor ¶
func (AlarmEventType_AlarmEventType) EnumDescriptor() ([]byte, []int)
func (AlarmEventType_AlarmEventType) String ¶
func (x AlarmEventType_AlarmEventType) String() string
type ConfigEvent ¶
type ConfigEvent struct { Type ConfigEventType_ConfigEventType `protobuf:"varint,1,opt,name=type,enum=voltha.ConfigEventType_ConfigEventType" json:"type,omitempty"` Hash string `protobuf:"bytes,2,opt,name=hash" json:"hash,omitempty"` Data string `protobuf:"bytes,3,opt,name=data" json:"data,omitempty"` }
func (*ConfigEvent) Descriptor ¶
func (*ConfigEvent) Descriptor() ([]byte, []int)
func (*ConfigEvent) GetData ¶
func (m *ConfigEvent) GetData() string
func (*ConfigEvent) GetHash ¶
func (m *ConfigEvent) GetHash() string
func (*ConfigEvent) GetType ¶
func (m *ConfigEvent) GetType() ConfigEventType_ConfigEventType
func (*ConfigEvent) ProtoMessage ¶
func (*ConfigEvent) ProtoMessage()
func (*ConfigEvent) Reset ¶
func (m *ConfigEvent) Reset()
func (*ConfigEvent) String ¶
func (m *ConfigEvent) String() string
type ConfigEventType ¶
type ConfigEventType struct { }
func (*ConfigEventType) Descriptor ¶
func (*ConfigEventType) Descriptor() ([]byte, []int)
func (*ConfigEventType) ProtoMessage ¶
func (*ConfigEventType) ProtoMessage()
func (*ConfigEventType) Reset ¶
func (m *ConfigEventType) Reset()
func (*ConfigEventType) String ¶
func (m *ConfigEventType) String() string
type ConfigEventType_ConfigEventType ¶
type ConfigEventType_ConfigEventType int32
const ( ConfigEventType_add ConfigEventType_ConfigEventType = 0 ConfigEventType_remove ConfigEventType_ConfigEventType = 1 ConfigEventType_update ConfigEventType_ConfigEventType = 2 )
func (ConfigEventType_ConfigEventType) EnumDescriptor ¶
func (ConfigEventType_ConfigEventType) EnumDescriptor() ([]byte, []int)
func (ConfigEventType_ConfigEventType) String ¶
func (x ConfigEventType_ConfigEventType) String() string
type KpiEvent ¶
type KpiEvent struct { Type KpiEventType_KpiEventType `protobuf:"varint,1,opt,name=type,enum=voltha.KpiEventType_KpiEventType" json:"type,omitempty"` Ts float32 `protobuf:"fixed32,2,opt,name=ts" json:"ts,omitempty"` Prefixes map[string]*MetricValuePairs `` /* 136-byte string literal not displayed */ }
func (*KpiEvent) Descriptor ¶
func (*KpiEvent) GetPrefixes ¶
func (m *KpiEvent) GetPrefixes() map[string]*MetricValuePairs
func (*KpiEvent) GetType ¶
func (m *KpiEvent) GetType() KpiEventType_KpiEventType
func (*KpiEvent) ProtoMessage ¶
func (*KpiEvent) ProtoMessage()
type KpiEventType ¶
type KpiEventType struct { }
func (*KpiEventType) Descriptor ¶
func (*KpiEventType) Descriptor() ([]byte, []int)
func (*KpiEventType) ProtoMessage ¶
func (*KpiEventType) ProtoMessage()
func (*KpiEventType) Reset ¶
func (m *KpiEventType) Reset()
func (*KpiEventType) String ¶
func (m *KpiEventType) String() string
type KpiEventType_KpiEventType ¶
type KpiEventType_KpiEventType int32
const ( KpiEventType_slice KpiEventType_KpiEventType = 0 KpiEventType_ts KpiEventType_KpiEventType = 1 )
func (KpiEventType_KpiEventType) EnumDescriptor ¶
func (KpiEventType_KpiEventType) EnumDescriptor() ([]byte, []int)
func (KpiEventType_KpiEventType) String ¶
func (x KpiEventType_KpiEventType) String() string
type MetricValuePairs ¶
type MetricValuePairs struct { // Metric / value pairs. Metrics map[string]float32 `` /* 136-byte string literal not displayed */ }
Struct to convey a dictionary of metric->value pairs. Typically used in pure shared-timestamp or shared-timestamp + shared object prefix situations.
func (*MetricValuePairs) Descriptor ¶
func (*MetricValuePairs) Descriptor() ([]byte, []int)
func (*MetricValuePairs) GetMetrics ¶
func (m *MetricValuePairs) GetMetrics() map[string]float32
func (*MetricValuePairs) ProtoMessage ¶
func (*MetricValuePairs) ProtoMessage()
func (*MetricValuePairs) Reset ¶
func (m *MetricValuePairs) Reset()
func (*MetricValuePairs) String ¶
func (m *MetricValuePairs) String() string
Click to show internal directories.
Click to hide internal directories.