Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.alarms.rev190709.alarms.top.alarms

Interface Alarm

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Alarm>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Alarms>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AlarmKey>
    @Generated("mdsal-binding-generator")
public interface Alarm
extends org.opendaylight.yangtools.yang.binding.ChildOf<Alarms>, org.opendaylight.yangtools.yang.binding.Augmentable<Alarm>, org.opendaylight.yangtools.yang.binding.Identifiable<AlarmKey>
    List of alarms, keyed by a unique id

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

     list alarm {
   key id;
   leaf id {
     type leafref {
       path ../state/id;
     }
   }
   container config {
     uses alarm-config;
   }
   container state {
     config false;
     uses alarm-config;
     uses alarm-state;
   }
 }
    The schema path to identify an instance is openconfig-alarmsalarms-topalarmsalarm

    To create instances of this class use AlarmBuilder.

    See Also:
    AlarmBuilder, AlarmKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default Class<Alarm> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull Alarm obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Alarm thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Alarm obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • key

        AlarmKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<AlarmKey>

      • getId

        String getId()
        Return id, or null if it is not present. 
             
         References the unique alarm id
        Returns:
        String id, or null if it is not present.

      • requireId

        default @NonNull String requireId()
        Return id, guaranteed to be non-null. 
             
         References the unique alarm id
        Returns:
        String id, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if id is not present

      • getConfig

        Config getConfig()
        Return config, or null if it is not present. 
             
         Configuration data for each alarm
        Returns:
        Config config, or null if it is not present.

      • getState

        State getState()
        Return state, or null if it is not present. 
             
         Operational state data for a device alarm
        Returns:
        State state, or null if it is not present.