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.

**Note**: A new version of the Databricks SQL API is now available. Please see the latest version. [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) Create an alert.
LegacyAlert	create(String name, AlertOptions options, String queryId)
void	delete(DeleteAlertsLegacyRequest request) Delete an alert.
void	delete(String alertId)
LegacyAlert	get(GetAlertsLegacyRequest request) Get an alert.
LegacyAlert	get(String alertId)
AlertsLegacyService	impl()
Iterable<LegacyAlert>	list() Get alerts.
void	update(EditAlert request) Update an alert.
void	update(String alertId, String name, AlertOptions options, String queryId)

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(String name,
                          AlertOptions options,
                          String queryId)

create

public LegacyAlert create(CreateAlert request)

Create an alert.

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.

**Note**: A new version of the Databricks SQL API is now available. 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)

Delete an alert.

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.

**Note**: A new version of the Databricks SQL API is now available. 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)

Get an alert.

Gets an alert.

**Note**: A new version of the Databricks SQL API is now available. 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()

Get alerts.

Gets a list of alerts.

**Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/list instead. [Learn more]

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

update

public void update(String alertId,
                   String name,
                   AlertOptions options,
                   String queryId)

update

public void update(EditAlert request)

Update an alert.

Updates an alert.

**Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/update instead. [Learn more]

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

impl

public AlertsLegacyService impl()