com.databricks.sdk.service.catalog

Interface QualityMonitorsService

@Generated
public interface QualityMonitorsService

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.

Method Summary

Modifier and Type	Method and Description
void	cancelRefresh(CancelRefreshRequest cancelRefreshRequest) Cancels an already-initiated refresh job.
MonitorInfo	create(CreateMonitor createMonitor) Creates a new monitor for the specified table.
DeleteMonitorResponse	delete(DeleteQualityMonitorRequest deleteQualityMonitorRequest) Deletes a monitor for the specified table.
MonitorInfo	get(GetQualityMonitorRequest getQualityMonitorRequest) Gets a monitor for the specified table.
MonitorRefreshInfo	getRefresh(GetRefreshRequest getRefreshRequest) Gets info about a specific monitor refresh using the given refresh ID.
MonitorRefreshListResponse	listRefreshes(ListRefreshesRequest listRefreshesRequest) Gets an array containing the history of the most recent refreshes (up to 25) for this table.
RegenerateDashboardResponse	regenerateDashboard(RegenerateDashboardRequest regenerateDashboardRequest) Regenerates the monitoring dashboard for the specified table.
MonitorRefreshInfo	runRefresh(RunRefreshRequest runRefreshRequest) Queues a metric refresh on the monitor for the specified table.
MonitorInfo	update(UpdateMonitor updateMonitor) Updates a monitor for the specified table.

Method Detail

cancelRefresh

void cancelRefresh(CancelRefreshRequest cancelRefreshRequest)

Cancels an already-initiated refresh job.

create

MonitorInfo create(CreateMonitor createMonitor)

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.

delete

DeleteMonitorResponse delete(DeleteQualityMonitorRequest deleteQualityMonitorRequest)

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).

get

MonitorInfo get(GetQualityMonitorRequest getQualityMonitorRequest)

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.

getRefresh

MonitorRefreshInfo getRefresh(GetRefreshRequest getRefreshRequest)

Gets info about a specific monitor refresh using the given refresh ID.

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.

Additionally, the call must be made from the workspace where the monitor was created.

listRefreshes

MonitorRefreshListResponse listRefreshes(ListRefreshesRequest listRefreshesRequest)

Gets an array containing the history of the most recent refreshes (up to 25) for this 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.

Additionally, the call must be made from the workspace where the monitor was created.

regenerateDashboard

RegenerateDashboardResponse regenerateDashboard(RegenerateDashboardRequest regenerateDashboardRequest)

Regenerates the monitoring dashboard 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

The call must be made from the workspace where the monitor was created. The dashboard will be regenerated in the assets directory that was specified when the monitor was created.

runRefresh

MonitorRefreshInfo runRefresh(RunRefreshRequest runRefreshRequest)

Queues a metric refresh on the monitor for the specified table. The refresh will execute in the background.

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.

update

MonitorInfo update(UpdateMonitor updateMonitor)

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.