Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AlertRuleUpdatable<T>

Updates existing alert rule by it's uid. Only specified (non undefined) values are changed. The omitted values are kept as before update.

Type parameters

Hierarchy

Index

Properties

Optional action

action: null | AlertAction

Optionally specify the action of alert rule. This action will happen when alert rule is creating an alert. It can be omitted as null, which means that there is no action emitted when alert is created (alert is only visible in UI).

alertRuleUid

alertRuleUid: string

Unique identifier for each alert rule across system

Optional alertType

alertType: T

Type of alert which can be mapped to human readable text in UI.

Optional conditions

conditions: AlertConditions<T>

Specify all conditions which devices has to match to state alert as applicable. When device is matching the conditions, it doesn't create alert yet. But the alert rule continues to be compared against specified threshold. This is the second stage of 3 stages of rule before the alert is created.

Optional description

description: string

User defined description for the alert rule which can be changed later

Optional filter

filter: AlertFilter

Pre-filter of devices which the alert will be checked against. It's used for percentage threshold of alert creation as base. The mandatory filter is organization set above. This is extended filter for example device applicationType (tizen, webos, etc.). This is the first stage of 3 stages of rule before the alert is created.

Optional name

name: string

User defined name for the alert rule which can be changed later

Optional organizationUids

organizationUids: string[]

Organizations which is checked against the rule. There can be one or more organizations. However, some alertTypes (e.g.: POLICY_VIOLATION) can be limited only to single organization.

Optional periodicity

periodicity: number

Specify how often the rule will be checked against the current state of devices. The shorter periodicity will be, the alert rule is more costly on infrastructure. And even the shorter periodicity will be, user will be alerted in case of the same kind of alert was archived.

Optional threshold

threshold: AlertThreshold

Specify threshold of rule. It is comparing number of devices matched the conditions above relatively against the total number devices filtered by filter above. This is the last stage of 3 stages of rule. When this rule is matched, finally the alert is created.

Generated using TypeDoc