All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: State

@Generated("mdsal-binding-generator")
public interface AlarmState
extends org.opendaylight.yangtools.yang.binding.DataObject

Operational state data for device alarms

This class represents the following YANG schema fragment defined in module openconfig-alarms

 grouping alarm-state {
   leaf id {
     type string;
   }
   leaf resource {
     type string;
   }
   leaf text {
     type string;
   }
   leaf time-created {
     type oc-types:timeticks64;
   }
   leaf severity {
     type identityref {
       base OPENCONFIG_ALARM_SEVERITY;
     }
   }
   leaf type-id {
     type union {
       type string;
       type identityref {
         base OPENCONFIG_ALARM_TYPE_ID;
       }
     }
   }
 }

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class AlarmState.TypeId

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
YANG identifier of the statement represented by this class.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getId()`	Return id, or `null` if it is not present.
`String`	`getResource()`	Return resource, or `null` if it is not present.
`Class<? extends OPENCONFIGALARMSEVERITY>`	`getSeverity()`	Return severity, or `null` if it is not present.
`String`	`getText()`	Return text, or `null` if it is not present.
`Timeticks64`	`getTimeCreated()`	Return timeCreated, or `null` if it is not present.
`AlarmState.TypeId`	`getTypeId()`	Return typeId, or `null` if it is not present.
`Class<? extends AlarmState>`	`implementedInterface()`
`default @NonNull String`	`requireId()`	Return id, guaranteed to be non-null.
`default @NonNull String`	`requireResource()`	Return resource, guaranteed to be non-null.
`default @NonNull Class<? extends OPENCONFIGALARMSEVERITY>`	`requireSeverity()`	Return severity, guaranteed to be non-null.
`default @NonNull String`	`requireText()`	Return text, guaranteed to be non-null.
`default @NonNull Timeticks64`	`requireTimeCreated()`	Return timeCreated, guaranteed to be non-null.
`default @NonNull AlarmState.TypeId`	`requireTypeId()`	Return typeId, guaranteed to be non-null.

Field Detail
- QNAME
```
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
```
  YANG identifier of the statement represented by this class.

Method Detail

implementedInterface
```
Class<? extends AlarmState> implementedInterface()
```
Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

getId

String getId()

Return id, or null if it is not present.

     
         Unique ID for the alarm -- this will not be a configurable parameter on many
         implementations

Returns:: String id, or null if it is not present.

requireId

default @NonNull String requireId()

Return id, guaranteed to be non-null.

     
         Unique ID for the alarm -- this will not be a configurable parameter on many
         implementations

Returns:: String id, guaranteed to be non-null.
Throws:: NoSuchElementException - if id is not present

getResource

String getResource()

Return resource, or null if it is not present.

     
         The item that is under alarm within the device. The resource may be a reference
         to an item which is defined elsewhere in the model. For example, it may be a
         platform/component, interfaces/interface,
         terminal-device/logical-channels/channel, etc. In this case the system should
         match the name of the referenced item exactly. The referenced item could
         alternatively be the path of the item within the model.

Returns:: String resource, or null if it is not present.

requireResource

default @NonNull String requireResource()

Return resource, guaranteed to be non-null.

     
         The item that is under alarm within the device. The resource may be a reference
         to an item which is defined elsewhere in the model. For example, it may be a
         platform/component, interfaces/interface,
         terminal-device/logical-channels/channel, etc. In this case the system should
         match the name of the referenced item exactly. The referenced item could
         alternatively be the path of the item within the model.

Returns:: String resource, guaranteed to be non-null.
Throws:: NoSuchElementException - if resource is not present

getText

String getText()

Return text, or null if it is not present.

     
         The string used to inform operators about the alarm. This MUST contain enough
         information for an operator to be able to understand the problem. If this string
         contains structure, this format should be clearly documented for programs to be
         able to parse that information

Returns:: String text, or null if it is not present.

requireText

default @NonNull String requireText()

Return text, guaranteed to be non-null.

     
         The string used to inform operators about the alarm. This MUST contain enough
         information for an operator to be able to understand the problem. If this string
         contains structure, this format should be clearly documented for programs to be
         able to parse that information

Returns:: String text, guaranteed to be non-null.
Throws:: NoSuchElementException - if text is not present

getTimeCreated

Timeticks64 getTimeCreated()

Return timeCreated, or null if it is not present.

     
         The time at which the alarm was raised by the system. This value is expressed
         relative to the Unix Epoch.

Returns:: Timeticks64 timeCreated, or null if it is not present.

requireTimeCreated

default @NonNull Timeticks64 requireTimeCreated()

Return timeCreated, guaranteed to be non-null.

     
         The time at which the alarm was raised by the system. This value is expressed
         relative to the Unix Epoch.

Returns:: Timeticks64 timeCreated, guaranteed to be non-null.
Throws:: NoSuchElementException - if timeCreated is not present

getSeverity

Class<? extends OPENCONFIGALARMSEVERITY> getSeverity()

Return severity, or null if it is not present.

     
         The severity level indicating the criticality and impact of the alarm

Returns:: Class<? extends OPENCONFIGALARMSEVERITY> severity, or null if it is not present.

requireSeverity
```
default @NonNull Class<? extends OPENCONFIGALARMSEVERITY> requireSeverity()
```
Return severity, guaranteed to be non-null.
```
     
         The severity level indicating the criticality and impact of the alarm
     
 
```
Returns:

Class<? extends OPENCONFIGALARMSEVERITY> severity, guaranteed to be non-null.

Throws:

NoSuchElementException - if severity is not present

getTypeId

AlarmState.TypeId getTypeId()

Return typeId, or null if it is not present.

     
         The abbreviated name of the alarm, for example LOS, EQPT, or OTS. Also referred
         to in different systems as condition type, alarm identifier, or alarm mnemonic.
         It is recommended to use the OPENCONFIG_ALARM_TYPE_ID identities where possible
         and only use the string type when the desired identityref is not yet defined

Returns:: TypeId typeId, or null if it is not present.

requireTypeId

default @NonNull AlarmState.TypeId requireTypeId()

Return typeId, guaranteed to be non-null.

     
         The abbreviated name of the alarm, for example LOS, EQPT, or OTS. Also referred
         to in different systems as condition type, alarm identifier, or alarm mnemonic.
         It is recommended to use the OPENCONFIG_ALARM_TYPE_ID identities where possible
         and only use the string type when the desired identityref is not yet defined

Returns:: TypeId typeId, guaranteed to be non-null.
Throws:: NoSuchElementException - if typeId is not present

Interface AlarmState

Nested Class Summary

Field Summary