com.databricks.sdk.service.dataquality

Interface DataQualityService

@Generated
public interface DataQualityService

Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)

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
CancelRefreshResponse	cancelRefresh(CancelRefreshRequest cancelRefreshRequest) Cancels a data quality monitor refresh.
Monitor	createMonitor(CreateMonitorRequest createMonitorRequest) Create a data quality monitor on a Unity Catalog object.
Refresh	createRefresh(CreateRefreshRequest createRefreshRequest) Creates a refresh.
void	deleteMonitor(DeleteMonitorRequest deleteMonitorRequest) Delete a data quality monitor on Unity Catalog object.
void	deleteRefresh(DeleteRefreshRequest deleteRefreshRequest) (Unimplemented) Delete a refresh
Monitor	getMonitor(GetMonitorRequest getMonitorRequest) Read a data quality monitor on a Unity Catalog object.
Refresh	getRefresh(GetRefreshRequest getRefreshRequest) Get data quality monitor refresh.
ListMonitorResponse	listMonitor(ListMonitorRequest listMonitorRequest) (Unimplemented) List data quality monitors.
ListRefreshResponse	listRefresh(ListRefreshRequest listRefreshRequest) List data quality monitor refreshes.
Monitor	updateMonitor(UpdateMonitorRequest updateMonitorRequest) Update a data quality monitor on Unity Catalog object.
Refresh	updateRefresh(UpdateRefreshRequest updateRefreshRequest) (Unimplemented) Update a refresh

Method Detail

cancelRefresh

CancelRefreshResponse cancelRefresh(CancelRefreshRequest cancelRefreshRequest)

Cancels a data quality monitor refresh. Currently only supported for the `table` `object_type`. The call must be made in the same workspace as where the monitor was created.

The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.

createMonitor

Monitor createMonitor(CreateMonitorRequest createMonitorRequest)

Create a data quality monitor on a Unity Catalog object. The caller must provide either `anomaly_detection_config` for a schema monitor or `data_profiling_config` for a table monitor.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table 2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** and **SELECT** on the table.

Workspace assets, such as the dashboard, will be created in the workspace where this call was made.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.

createRefresh

Refresh createRefresh(CreateRefreshRequest createRefreshRequest)

Creates a refresh. Currently only supported for the `table` `object_type`. The call must be made in the same workspace as where the monitor was created.

The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.

deleteMonitor

void deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)

Delete a data quality monitor on Unity Catalog object.

For the `table` `object_type`, the caller must have either of the following sets of permissions: **MANAGE** and **USE_CATALOG** on the table's parent catalog. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.

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

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.

deleteRefresh

void deleteRefresh(DeleteRefreshRequest deleteRefreshRequest)

(Unimplemented) Delete a refresh

getMonitor

Monitor getMonitor(GetMonitorRequest getMonitorRequest)

Read a data quality monitor on a Unity Catalog object.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.

The returned information includes configuration values on the entity and parent entity 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

Refresh getRefresh(GetRefreshRequest getRefreshRequest)

Get data quality monitor refresh. The call must be made in the same workspace as where the monitor was created.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.

listMonitor

ListMonitorResponse listMonitor(ListMonitorRequest listMonitorRequest)

(Unimplemented) List data quality monitors.

listRefresh

ListRefreshResponse listRefresh(ListRefreshRequest listRefreshRequest)

List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.

updateMonitor

Monitor updateMonitor(UpdateMonitorRequest updateMonitorRequest)

Update a data quality monitor on Unity Catalog object.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.

updateRefresh

Refresh updateRefresh(UpdateRefreshRequest updateRefreshRequest)

(Unimplemented) Update a refresh