opennms/src/api/IHasUrlValue.ts

Client API for the OpenNMS network monitoring platform

/**
 * Interface for a class that has a URL value.
 *
 * Any module implementing this interface should have a `urlValue` property
 * (ideally a property `get`ter) which represents how the object should be
 * represented when serialized to an OpenNMS URL parameter.
 *
 * @interface
 * @category Rest
 */
export interface IHasUrlValue {
  /** The value of this object when added to an OpenNMS URL parameter. */
  urlValue: string;
}