com.databricks.sdk.service.catalog.LakehouseMonitorsService Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.catalog;
import com.databricks.sdk.support.Generated;
/**
* A monitor computes and monitors data or model quality metrics for a table over time. It generates
* metrics tables and a dashboard that you can use to monitor table health and set alerts.
*
* Most write operations require the user to be the owner of the table (or its parent schema or
* parent catalog). Viewing the dashboard, computed metrics, or monitor configuration only requires
* the user to have **SELECT** privileges on the table (along with **USE_SCHEMA** and
* **USE_CATALOG**).
*
*
This is the high-level interface, that contains generated methods.
*
*
Evolving: this interface is under development. Method signatures may change.
*/
@Generated
public interface LakehouseMonitorsService {
/**
* Create a table monitor.
*
*
Creates a new monitor for the specified table.
*
*
The caller must either: 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on
* the table's parent schema, and have **SELECT** access on the table 2. have **USE_CATALOG** on
* the table's parent catalog, be an owner of the table's parent schema, and have **SELECT**
* access on the table. 3. have the following permissions: - **USE_CATALOG** on the table's parent
* catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table.
*
*
Workspace assets, such as the dashboard, will be created in the workspace where this call
* was made.
*/
MonitorInfo create(CreateMonitor createMonitor);
/**
* Delete a table monitor.
*
*
Deletes a monitor for the specified table.
*
*
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
* on the table's parent catalog and be an owner of the table's parent schema 3. have the
* following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
* table's parent schema - be an owner of the table.
*
*
Additionally, the call must be made from the workspace where the monitor was created.
*
*
Note that the metric tables and dashboard will not be deleted as part of this call; those
* assets must be manually cleaned up (if desired).
*/
void delete(DeleteLakehouseMonitorRequest deleteLakehouseMonitorRequest);
/**
* Get a table monitor.
*
*
Gets a monitor for the specified table.
*
*
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
* on the table's parent catalog and be an owner of the table's parent schema. 3. have the
* following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
* table's parent schema - **SELECT** privilege on the table.
*
*
The returned information includes configuration values, as well as information on assets
* created by the monitor. Some information (e.g., dashboard) may be filtered out if the caller is
* in a different workspace than where the monitor was created.
*/
MonitorInfo get(GetLakehouseMonitorRequest getLakehouseMonitorRequest);
/**
* Update a table monitor.
*
*
Updates a monitor for the specified table.
*
*
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
* on the table's parent catalog and be an owner of the table's parent schema 3. have the
* following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
* table's parent schema - be an owner of the table.
*
*
Additionally, the call must be made from the workspace where the monitor was created, and
* the caller must be the original creator of the monitor.
*
*
Certain configuration fields, such as output asset identifiers, cannot be updated.
*/
MonitorInfo update(UpdateMonitor updateMonitor);
}