com.databricks.sdk.service.catalog

Class LakehouseMonitorsAPI

java.lang.Object

com.databricks.sdk.service.catalog.LakehouseMonitorsAPI

@Generated
public class LakehouseMonitorsAPI
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
LakehouseMonitorsAPI(ApiClient apiClient) Regular-use constructor
LakehouseMonitorsAPI(LakehouseMonitorsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
MonitorInfo	create(CreateMonitor request) Create a table monitor.
MonitorInfo	create(String fullName, String assetsDir, String outputSchemaName)
void	delete(DeleteLakehouseMonitorRequest request) Delete a table monitor.
void	delete(String fullName)
MonitorInfo	get(GetLakehouseMonitorRequest request) Get a table monitor.
MonitorInfo	get(String fullName)
LakehouseMonitorsService	impl()
MonitorInfo	update(String fullName, String assetsDir, 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

LakehouseMonitorsAPI

public LakehouseMonitorsAPI(ApiClient apiClient)

Regular-use constructor

LakehouseMonitorsAPI

public LakehouseMonitorsAPI(LakehouseMonitorsService mock)

Constructor for mocks

Method Detail

create

public MonitorInfo create(String fullName,
                          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 fullName)

delete

public void delete(DeleteLakehouseMonitorRequest 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 fullName)

get

public MonitorInfo get(GetLakehouseMonitorRequest 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.

update

public MonitorInfo update(String fullName,
                          String assetsDir,
                          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 LakehouseMonitorsService impl()