Class NotificationChannelsResource

Notification channels — /v2/alertRules/notification-channel.

Index

Constructors

Methods

create delete get list test update

Constructors

constructor

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

Methods

create

create(options: CreateNotificationChannelOptions): Promise<NotificationChannel>
Parameters
- options: CreateNotificationChannelOptions
Returns Promise<NotificationChannel>

delete

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

get

get(channelId: string): Promise<NotificationChannel>
Parameters
- channelId: string
Returns Promise<NotificationChannel>

list

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

test

test(options: CreateNotificationChannelOptions): Promise<unknown>
Fire a test notification through a channel config.
Parameters
- options: CreateNotificationChannelOptions
Returns Promise<unknown>

update

update(
channelId: string,
options: UpdateNotificationChannelOptions,
): Promise<NotificationChannel>
Parameters
- channelId: string
- options: UpdateNotificationChannelOptions
Returns Promise<NotificationChannel>