QualityMonitorsService (databricks-sdk-java 0.26.0 API)

```
@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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cancelRefresh(CancelRefreshRequest cancelRefreshRequest)` Cancel refresh.
`MonitorInfo`	`create(CreateMonitor createMonitor)` Create a table monitor.
`void`	`delete(DeleteQualityMonitorRequest deleteQualityMonitorRequest)` Delete a table monitor.
`MonitorInfo`	`get(GetQualityMonitorRequest getQualityMonitorRequest)` Get a table monitor.
`MonitorRefreshInfo`	`getRefresh(GetRefreshRequest getRefreshRequest)` Get refresh.
`MonitorRefreshListResponse`	`listRefreshes(ListRefreshesRequest listRefreshesRequest)` List refreshes.
`MonitorRefreshInfo`	`runRefresh(RunRefreshRequest runRefreshRequest)` Queue a metric refresh for a monitor.
`MonitorInfo`	`update(UpdateMonitor updateMonitor)` Update a table monitor.

- Method Detail
  - cancelRefresh
```
void cancelRefresh(CancelRefreshRequest cancelRefreshRequest)
```
    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
```
MonitorInfo create(CreateMonitor createMonitor)
```
    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
```
void delete(DeleteQualityMonitorRequest deleteQualityMonitorRequest)
```
    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
```
MonitorInfo get(GetQualityMonitorRequest getQualityMonitorRequest)
```
    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
```
MonitorRefreshInfo getRefresh(GetRefreshRequest getRefreshRequest)
```
    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
```
MonitorRefreshListResponse listRefreshes(ListRefreshesRequest listRefreshesRequest)
```
    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
```
MonitorRefreshInfo runRefresh(RunRefreshRequest runRefreshRequest)
```
    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
```
MonitorInfo update(UpdateMonitor updateMonitor)
```
    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.

Interface QualityMonitorsService

Method Summary

Method Detail

cancelRefresh

create

delete

get

getRefresh

listRefreshes

runRefresh

update