opennms/src/model/OnmsAlarmSummary.ts

Client API for the OpenNMS network monitoring platform

import {Moment} from 'moment';

import {IHasUrlValue} from '../api/IHasUrlValue';
import {OnmsAlarmType} from './OnmsAlarmType';
import {OnmsSeverity} from './OnmsSeverity';

/**
 * Represents an OpenNMS alarm.
 * @module OnmsAlarm
 */
export class OnmsAlarmSummary implements IHasUrlValue {
  /** the alarm ID */
  public id: number;

  /** the alarm's reduction key */
  public reductionKey: string;

  /** the alarm's type */
  public type: OnmsAlarmType;

  /** the alarm's severity */
  public severity: OnmsSeverity;

  /** the alarm's description */
  public description: string;

  /** the alarm's log message */
  public logMessage: string;

  /** the label of this alarm as defined in the alarm configuration */
  public label: string;

  public get urlValue() {
    return String(this.id);
  }
}