com.databricks.sdk.service.sql

Class AlertsAPI

java.lang.Object

com.databricks.sdk.service.sql.AlertsAPI

@Generated
public class AlertsAPI
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 will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

Constructor Summary

Constructors

Constructor and Description
AlertsAPI(AlertsService mock) Constructor for mocks
AlertsAPI(ApiClient apiClient) Regular-use constructor

Method Summary

Modifier and Type	Method and Description
Alert	create(CreateAlert request) Create an alert.
Alert	create(String name, AlertOptions options, String queryId)
void	delete(DeleteAlertRequest request) Delete an alert.
void	delete(String alertId)
Alert	get(GetAlertRequest request) Get an alert.
Alert	get(String alertId)
AlertsService	impl()
Iterable<Alert>	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

AlertsAPI

public AlertsAPI(ApiClient apiClient)

Regular-use constructor

AlertsAPI

public AlertsAPI(AlertsService mock)

Constructor for mocks

Method Detail

create

public Alert create(String name,
                    AlertOptions options,
                    String queryId)

create

public Alert 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 will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

delete

public void delete(String alertId)

delete

public void delete(DeleteAlertRequest 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 will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

get

public Alert get(String alertId)

get

public Alert get(GetAlertRequest request)

Get an alert.

Gets an alert.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

list

public Iterable<Alert> list()

Get alerts.

Gets a list of alerts.

**Note**: A new version of the Databricks SQL API will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

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 will soon be available. [Learn more]

[Learn more]: https://docs.databricks.com/en/whats-coming.html#updates-to-the-databricks-sql-api-for-managing-queries-alerts-and-data-sources

impl

public AlertsService impl()