com.databricks.sdk.service.sql

Class AlertsLegacyAPI

java.lang.Object

com.databricks.sdk.service.sql.AlertsLegacyAPI

@Generated
public class AlertsLegacyAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
AlertsLegacyAPI(AlertsLegacyService mock) Constructor for mocks
AlertsLegacyAPI(ApiClient apiClient) Regular-use constructor

Method Summary

Modifier and Type	Method and Description
LegacyAlert	create(CreateAlert request) Creates an alert.
void	delete(DeleteAlertsLegacyRequest request) Deletes an alert.
void	delete(String alertId)
LegacyAlert	get(GetAlertsLegacyRequest request) Gets an alert.
LegacyAlert	get(String alertId)
AlertsLegacyService	impl()
Iterable<LegacyAlert>	list() Gets a list of alerts.
void	update(EditAlert request) Updates an alert.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlertsLegacyAPI

public AlertsLegacyAPI(ApiClient apiClient)

Regular-use constructor

AlertsLegacyAPI

public AlertsLegacyAPI(AlertsLegacyService mock)

Constructor for mocks

Method Detail

create

public LegacyAlert create(CreateAlert request)

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

public void delete(String alertId)

delete

public void delete(DeleteAlertsLegacyRequest request)

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

public LegacyAlert get(String alertId)

get

public LegacyAlert get(GetAlertsLegacyRequest request)

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

public Iterable<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

public void update(EditAlert request)

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

impl

public AlertsLegacyService impl()