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.

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(CreateAlertRequest request) Create an alert.
void	delete(String id)
void	delete(TrashAlertRequest request) Delete an alert.
Alert	get(GetAlertRequest request) Get an alert.
Alert	get(String id)
AlertsService	impl()
Iterable<ListAlertsResponseAlert>	list(ListAlertsRequest request) List alerts.
Alert	update(String id, String updateMask)
Alert	update(UpdateAlertRequest request) Update an alert.

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(CreateAlertRequest request)

Create an alert.

Creates an alert.

delete

public void delete(String id)

delete

public void delete(TrashAlertRequest request)

Delete an alert.

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

public Alert get(String id)

get

public Alert get(GetAlertRequest request)

Get an alert.

Gets an alert.

list

public Iterable<ListAlertsResponseAlert> list(ListAlertsRequest request)

List alerts.

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

public Alert update(String id,
                    String updateMask)

update

public Alert update(UpdateAlertRequest request)

Update an alert.

Updates an alert.

impl

public AlertsService impl()