Class AlertRulesResource

Alert rules API — /v2/alertRules (+ .channels and .metrics sub-resources).

Index

Constructors

Properties

channels metrics

Methods

create delete get list update

Constructors

constructor

new AlertRulesResource(http: HttpClient): AlertRulesResource
Parameters
- http: HttpClient
Returns AlertRulesResource

Properties

`Readonly`channels

channels: NotificationChannelsResource

`Readonly`metrics

metrics: AlertMetricsResource

Methods

create

create(options: CreateAlertRuleOptions): Promise<AlertRule>
Parameters
- options: CreateAlertRuleOptions
Returns Promise<AlertRule>

delete

delete(alertRuleId: string): Promise<MessageResponse>
Parameters
- alertRuleId: string
Returns Promise<MessageResponse>

get

get(alertRuleId: string): Promise<AlertRule>
Parameters
- alertRuleId: string
Returns Promise<AlertRule>

list

list(params?: ListAlertRulesParams): Promise<Page<AlertRule>>
Parameters
- params: ListAlertRulesParams = {}
Returns Promise<Page<AlertRule>>

update

update(alertRuleId: string, options: UpdateAlertRuleOptions): Promise<AlertRule>
Parameters
- alertRuleId: string
- options: UpdateAlertRuleOptions
Returns Promise<AlertRule>