opennms/src/model/OnmsNodeType.ts

Client API for the OpenNMS network monitoring platform

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

import {OnmsEnum, forId, forLabel} from '../internal/OnmsEnum';

/**
 * Represents an OpenNMS node type.
 * @category Model
 */
export class OnmsNodeType extends OnmsEnum<string> implements IHasUrlValue {
  /** Given an ID (A, D, etc.), return the corresponding node type object. */
  public static forId(id?: string) {
    return forId(NodeTypes, id);
  }

  /** Given a label (ACTIVE, etc.), return the corresponding node type object. */
  public static forLabel(label?: string) {
    return forLabel(NodeTypes, label);
  }

  /** @inheritdoc */
  public get urlValue() {
    return this.id;
  }
}

/* eslint-disable  */
/**
 * Contains constant instances of all node types.
 * @category Model
 */
export const NodeTypes = {
  /** Node is active */
  ACTIVE: new OnmsNodeType('A', 'ACTIVE'),
  /** Node is disabled */
  DELETED: new OnmsNodeType('D', 'DELETED'),
  /** Node state is unknown */
  UNKNOWN: new OnmsNodeType(' ', 'UNKNOWN'),
};
Object.freeze(NodeTypes);