Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118

Interface PlatformComponentTempAlarmState

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Temperature
@Generated("mdsal-binding-generator") public interface PlatformComponentTempAlarmState extends org.opendaylight.yangtools.yang.binding.DataObject
Temperature alarm data for platform components

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

 grouping platform-component-temp-alarm-state {
   leaf alarm-status {
     type boolean;
   }
   leaf alarm-threshold {
     type uint32;
   }
   leaf alarm-severity {
     type identityref {
       base OPENCONFIG_ALARM_SEVERITY;
     }
   }
 }

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

      Class<? extends PlatformComponentTempAlarmState> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getAlarmStatus

      Boolean getAlarmStatus()
      Return alarmStatus, or null if it is not present. 
           
         A value of true indicates the alarm has been raised or asserted. The value
         should be false when the alarm is cleared.
      Returns:
      Boolean alarmStatus, or null if it is not present.

    • requireAlarmStatus

      default @NonNull Boolean requireAlarmStatus()
      Return alarmStatus, guaranteed to be non-null. 
           
         A value of true indicates the alarm has been raised or asserted. The value
         should be false when the alarm is cleared.
      Returns:
      Boolean alarmStatus, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if alarmStatus is not present

    • getAlarmThreshold

      org.opendaylight.yangtools.yang.common.Uint32 getAlarmThreshold()
      Return alarmThreshold, or null if it is not present. 
           
         The threshold value that was crossed for this alarm.
      Returns:
      Uint32 alarmThreshold, or null if it is not present.

    • requireAlarmThreshold

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAlarmThreshold()
      Return alarmThreshold, guaranteed to be non-null. 
           
         The threshold value that was crossed for this alarm.
      Returns:
      Uint32 alarmThreshold, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if alarmThreshold is not present

    • getAlarmSeverity

      OPENCONFIGALARMSEVERITY getAlarmSeverity()
      Return alarmSeverity, or null if it is not present. 
           
         The severity of the current alarm.
      Returns:
      OPENCONFIGALARMSEVERITY alarmSeverity, or null if it is not present.

    • requireAlarmSeverity

      default @NonNull OPENCONFIGALARMSEVERITY requireAlarmSeverity()
      Return alarmSeverity, guaranteed to be non-null. 
           
         The severity of the current alarm.
      Returns:
      OPENCONFIGALARMSEVERITY alarmSeverity, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if alarmSeverity is not present