package org.opendaylight.yang.gen.v1.urn.etsi.osm.yang.augments.norev;
import java.lang.Boolean;
import java.lang.Class;
import java.lang.Override;
import java.lang.String;
import java.math.BigDecimal;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yang.gen.v1.urn.etsi.osm.yang.augments.norev.alarm.properties.Actions;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.Uint32;

/**
 * 
 * <p>
 * This class represents the following YANG schema fragment defined in module <b>common-augments</b>
 * <pre>
 * grouping alarm-properties {
 *   leaf name {
 *     type string;
 *   }
 *   leaf description {
 *     type string;
 *   }
 *   leaf vdur-id {
 *     type string;
 *   }
 *   container actions {
 *     list ok {
 *       key url;
 *       leaf url {
 *         type string;
 *       }
 *     }
 *     list insufficient-data {
 *       key url;
 *       leaf url {
 *         type string;
 *       }
 *     }
 *     list alarm {
 *       key url;
 *       leaf url {
 *         type string;
 *       }
 *     }
 *   }
 *   leaf repeat {
 *     type boolean;
 *     default true;
 *   }
 *   leaf enabled {
 *     type boolean;
 *     default true;
 *   }
 *   leaf severity {
 *     type alarm-severity-type;
 *   }
 *   leaf statistic {
 *     type alarm-statistic-type;
 *   }
 *   leaf operation {
 *     type relational-operation-type;
 *   }
 *   leaf value {
 *     type decimal64 {
 *       fraction-digits 4;
 *     }
 *   }
 *   leaf period {
 *     type uint32;
 *   }
 *   leaf evaluations {
 *     type uint32;
 *   }
 * }
 * </pre>The schema path to identify an instance is
 * <i>common-augments/alarm-properties</i>
 *
 */
public interface AlarmProperties
    extends
    DataObject
{



    public static final @NonNull QName QNAME = $YangModuleInfoImpl.qnameOf("alarm-properties");

    @Override
    Class<? extends AlarmProperties> implementedInterface();
    
    /**
     * A human readable string to identify the alarm
     *
     *
     *
     * @return <code>java.lang.String</code> <code>name</code>, or <code>null</code> if not present
     */
    @Nullable String getName();
    
    /**
     * A description of this alarm
     *
     *
     *
     * @return <code>java.lang.String</code> <code>description</code>, or <code>null</code> if not present
     */
    @Nullable String getDescription();
    
    /**
     * The identifier of the VDUR that the alarm is associated with
     *
     *
     *
     * @return <code>java.lang.String</code> <code>vdurId</code>, or <code>null</code> if not present
     */
    @Nullable String getVdurId();
    
    /**
     * @return <code>org.opendaylight.yang.gen.v1.urn.etsi.osm.yang.augments.norev.alarm.properties.Actions</code> <code>actions</code>, or <code>null</code> if not present
     */
    @Nullable Actions getActions();
    
    /**
     * This flag indicates whether the alarm should be repeatedly emitted while the
     * associated threshold has been crossed.
     *
     *
     *
     * @return <code>java.lang.Boolean</code> <code>repeat</code>, or <code>null</code> if not present
     */
    @Nullable Boolean isRepeat();
    
    /**
     * This flag indicates whether the alarm has been enabled or disabled.
     *
     *
     *
     * @return <code>java.lang.Boolean</code> <code>enabled</code>, or <code>null</code> if not present
     */
    @Nullable Boolean isEnabled();
    
    /**
     * A measure of the importance or urgency of the alarm
     *
     *
     *
     * @return <code>org.opendaylight.yang.gen.v1.urn.etsi.osm.yang.augments.norev.AlarmSeverityType</code> <code>severity</code>, or <code>null</code> if not present
     */
    @Nullable AlarmSeverityType getSeverity();
    
    /**
     * The type of metric statistic that is tracked by this alarm
     *
     *
     *
     * @return <code>org.opendaylight.yang.gen.v1.urn.etsi.osm.yang.augments.norev.AlarmStatisticType</code> <code>statistic</code>, or <code>null</code> if not present
     */
    @Nullable AlarmStatisticType getStatistic();
    
    /**
     * The relational operator used to define whether an alarm should be triggered in
     * certain scenarios, such as if the metric statistic goes above or below a
     * specified value.
     *
     *
     *
     * @return <code>org.opendaylight.yang.gen.v1.urn.etsi.osm.yang.augments.norev.RelationalOperationType</code> <code>operation</code>, or <code>null</code> if not present
     */
    @Nullable RelationalOperationType getOperation();
    
    /**
     * This value defines the threshold that, if crossed, will trigger the alarm.
     *
     *
     *
     * @return <code>java.math.BigDecimal</code> <code>value</code>, or <code>null</code> if not present
     */
    @Nullable BigDecimal getValue();
    
    /**
     * The period defines the length of time (seconds) that the metric data are
     * collected over in oreder to evaluate the chosen statistic.
     *
     *
     *
     * @return <code>org.opendaylight.yangtools.yang.common.Uint32</code> <code>period</code>, or <code>null</code> if not present
     */
    @Nullable Uint32 getPeriod();
    
    /**
     * Defines the length of time (seconds) in which metric data are collected in order
     * to evaluate the chosen statistic.
     *
     *
     *
     * @return <code>org.opendaylight.yangtools.yang.common.Uint32</code> <code>evaluations</code>, or <code>null</code> if not present
     */
    @Nullable Uint32 getEvaluations();

}

