com.databricks.sdk.service.sql

Interface AlertsLegacyService

@Generated
public interface AlertsLegacyService

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.

**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

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
LegacyAlert	create(CreateAlert createAlert) Creates an alert.
void	delete(DeleteAlertsLegacyRequest deleteAlertsLegacyRequest) Deletes an alert.
LegacyAlert	get(GetAlertsLegacyRequest getAlertsLegacyRequest) Gets an alert.
Collection<LegacyAlert>	list() Gets a list of alerts.
void	update(EditAlert editAlert) Updates an alert.

Method Detail

create

LegacyAlert create(CreateAlert createAlert)

Creates an alert. An alert is a Databricks SQL object that periodically runs a query, evaluates a condition of its result, and notifies users or notification destinations if the condition was met.

**Warning**: This API is deprecated. Please use :method:alerts/create instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

delete

void delete(DeleteAlertsLegacyRequest deleteAlertsLegacyRequest)

Deletes an alert. Deleted alerts are no longer accessible and cannot be restored. **Note**: Unlike queries and dashboards, alerts cannot be moved to the trash.

**Warning**: This API is deprecated. Please use :method:alerts/delete instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

get

LegacyAlert get(GetAlertsLegacyRequest getAlertsLegacyRequest)

Gets an alert.

**Warning**: This API is deprecated. Please use :method:alerts/get instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

list

Collection<LegacyAlert> list()

Gets a list of alerts.

**Warning**: This API is deprecated. Please use :method:alerts/list instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

update

void update(EditAlert editAlert)

Updates an alert.

**Warning**: This API is deprecated. Please use :method:alerts/update instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html