com.databricks.sdk.service.catalog

Class QualityMonitorsAPI

java.lang.Object

com.databricks.sdk.service.catalog.QualityMonitorsAPI

@Generated
public class QualityMonitorsAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
QualityMonitorsAPI(ApiClient apiClient) Regular-use constructor
QualityMonitorsAPI(QualityMonitorsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	cancelRefresh(CancelRefreshRequest request) Cancel refresh.
void	cancelRefresh(String tableName, String refreshId)
MonitorInfo	create(CreateMonitor request) Create a table monitor.
MonitorInfo	create(String tableName, String assetsDir, String outputSchemaName)
void	delete(DeleteQualityMonitorRequest request) Delete a table monitor.
void	delete(String tableName)
MonitorInfo	get(GetQualityMonitorRequest request) Get a table monitor.
MonitorInfo	get(String tableName)
MonitorRefreshInfo	getRefresh(GetRefreshRequest request) Get refresh.
MonitorRefreshInfo	getRefresh(String tableName, String refreshId)
QualityMonitorsService	impl()
MonitorRefreshListResponse	listRefreshes(ListRefreshesRequest request) List refreshes.
MonitorRefreshListResponse	listRefreshes(String tableName)
MonitorRefreshInfo	runRefresh(RunRefreshRequest request) Queue a metric refresh for a monitor.
MonitorRefreshInfo	runRefresh(String tableName)
MonitorInfo	update(String tableName, String outputSchemaName)
MonitorInfo	update(UpdateMonitor request) Update a table monitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualityMonitorsAPI

public QualityMonitorsAPI(ApiClient apiClient)

Regular-use constructor

QualityMonitorsAPI

public QualityMonitorsAPI(QualityMonitorsService mock)

Constructor for mocks

Method Detail

cancelRefresh

public void cancelRefresh(String tableName,
                          String refreshId)

cancelRefresh

public void cancelRefresh(CancelRefreshRequest request)

Cancel refresh.

Cancel an active monitor refresh for 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 - be an owner of the table

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

create

public MonitorInfo create(String tableName,
                          String assetsDir,
                          String outputSchemaName)

create

public MonitorInfo create(CreateMonitor request)

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.

delete

public void delete(String tableName)

delete

public void delete(DeleteQualityMonitorRequest request)

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

get

public MonitorInfo get(String tableName)

get

public MonitorInfo get(GetQualityMonitorRequest request)

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.

getRefresh

public MonitorRefreshInfo getRefresh(String tableName,
                                     String refreshId)

getRefresh

public MonitorRefreshInfo getRefresh(GetRefreshRequest request)

Get refresh.

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

public MonitorRefreshListResponse listRefreshes(String tableName)

listRefreshes

public MonitorRefreshListResponse listRefreshes(ListRefreshesRequest request)

List refreshes.

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.

runRefresh

public MonitorRefreshInfo runRefresh(String tableName)

runRefresh

public MonitorRefreshInfo runRefresh(RunRefreshRequest request)

Queue a metric refresh for a monitor.

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

public MonitorInfo update(String tableName,
                          String outputSchemaName)

update

public MonitorInfo update(UpdateMonitor request)

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.

impl

public QualityMonitorsService impl()