com.databricks.sdk.service.sql

Interface AlertsService

@Generated
public interface AlertsService

The alerts API can be used to perform CRUD operations on alerts. An alert is a Databricks SQL object that periodically runs a query, evaluates a condition of its result, and notifies one or more users and/or notification destinations if the condition was met. Alerts can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
Alert	create(CreateAlertRequest createAlertRequest) Creates an alert.
void	delete(TrashAlertRequest trashAlertRequest) Moves an alert to the trash.
Alert	get(GetAlertRequest getAlertRequest) Gets an alert.
ListAlertsResponse	list(ListAlertsRequest listAlertsRequest) Gets a list of alerts accessible to the user, ordered by creation time.
Alert	update(UpdateAlertRequest updateAlertRequest) Updates an alert.

Method Detail

create

Alert create(CreateAlertRequest createAlertRequest)

Creates an alert.

delete

void delete(TrashAlertRequest trashAlertRequest)

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.

get

Alert get(GetAlertRequest getAlertRequest)

Gets an alert.

list

ListAlertsResponse list(ListAlertsRequest listAlertsRequest)

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.

update

Alert update(UpdateAlertRequest updateAlertRequest)

Updates an alert.