Class AlertsClient

Index

Constructors

Methods

createAlert getAlert listAlerts listAlertsIter trashAlert updateAlert

Constructors

constructor

new AlertsClient(options: ClientOptions): AlertsClient
Parameters
- options: ClientOptions
Returns AlertsClient
- Defined in v1/client.ts:56

Methods

createAlert

createAlert(req: CreateAlertRequest, options?: CallOptions): Promise<Alert>
Creates an alert.
Parameters
- req: CreateAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Alert>
- Defined in v1/client.ts:72

getAlert

getAlert(req: GetAlertRequest, options?: CallOptions): Promise<Alert>
Gets an alert.
Parameters
- req: GetAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Alert>
- Defined in v1/client.ts:102

listAlerts

listAlerts(
req: ListAlertsRequest,
options?: CallOptions,
): Promise<ListAlertsResponse>
Gets a list of alerts accessible to the user, ordered by creation time. Warning: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.
Parameters
- req: ListAlertsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAlertsResponse>
- Defined in v1/client.ts:128

listAlertsIter

listAlertsIter(
req: ListAlertsRequest,
options?: CallOptions,
): AsyncGenerator<ListAlertsResponseAlert>
Parameters
- req: ListAlertsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ListAlertsResponseAlert>
- Defined in v1/client.ts:165

trashAlert

trashAlert(req: TrashAlertRequest, options?: CallOptions): Promise<Empty>
Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.
Parameters
- req: TrashAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Empty>
- Defined in v1/client.ts:183

updateAlert

updateAlert(req: UpdateAlertRequest, options?: CallOptions): Promise<Alert>
Updates an alert.
Parameters
- req: UpdateAlertRequest
- Optionaloptions: CallOptions
Returns Promise<Alert>
- Defined in v1/client.ts:212