com.databricks.sdk.service.dataquality

Class DataQualityAPI

java.lang.Object

com.databricks.sdk.service.dataquality.DataQualityAPI

@Generated
public class DataQualityAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
DataQualityAPI(ApiClient apiClient) Regular-use constructor
DataQualityAPI(DataQualityService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CancelRefreshResponse	cancelRefresh(CancelRefreshRequest request) Cancels a data quality monitor refresh.
Monitor	createMonitor(CreateMonitorRequest request) Create a data quality monitor on a Unity Catalog object.
Refresh	createRefresh(CreateRefreshRequest request) Creates a refresh.
void	deleteMonitor(DeleteMonitorRequest request) Delete a data quality monitor on Unity Catalog object.
void	deleteMonitor(String objectType, String objectId)
void	deleteRefresh(DeleteRefreshRequest request) (Unimplemented) Delete a refresh
void	deleteRefresh(String objectType, String objectId, long refreshId)
Monitor	getMonitor(GetMonitorRequest request) Read a data quality monitor on a Unity Catalog object.
Monitor	getMonitor(String objectType, String objectId)
Refresh	getRefresh(GetRefreshRequest request) Get data quality monitor refresh.
Refresh	getRefresh(String objectType, String objectId, long refreshId)
DataQualityService	impl()
Iterable<Monitor>	listMonitor(ListMonitorRequest request) (Unimplemented) List data quality monitors.
Iterable<Refresh>	listRefresh(ListRefreshRequest request) List data quality monitor refreshes.
Iterable<Refresh>	listRefresh(String objectType, String objectId)
Monitor	updateMonitor(UpdateMonitorRequest request) Update a data quality monitor on Unity Catalog object.
Refresh	updateRefresh(UpdateRefreshRequest request) (Unimplemented) Update a refresh

Methods inherited from class java.lang.Object

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

Constructor Detail

DataQualityAPI

public DataQualityAPI(ApiClient apiClient)

Regular-use constructor

DataQualityAPI

public DataQualityAPI(DataQualityService mock)

Constructor for mocks

Method Detail

cancelRefresh

public CancelRefreshResponse cancelRefresh(CancelRefreshRequest request)

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

public Monitor createMonitor(CreateMonitorRequest request)

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

public Refresh createRefresh(CreateRefreshRequest request)

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

public void deleteMonitor(String objectType,
                          String objectId)

deleteMonitor

public void deleteMonitor(DeleteMonitorRequest request)

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

public void deleteRefresh(String objectType,
                          String objectId,
                          long refreshId)

deleteRefresh

public void deleteRefresh(DeleteRefreshRequest request)

(Unimplemented) Delete a refresh

getMonitor

public Monitor getMonitor(String objectType,
                          String objectId)

getMonitor

public Monitor getMonitor(GetMonitorRequest request)

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

public Refresh getRefresh(String objectType,
                          String objectId,
                          long refreshId)

getRefresh

public Refresh getRefresh(GetRefreshRequest request)

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

public Iterable<Monitor> listMonitor(ListMonitorRequest request)

(Unimplemented) List data quality monitors.

listRefresh

public Iterable<Refresh> listRefresh(String objectType,
                                     String objectId)

listRefresh

public Iterable<Refresh> listRefresh(ListRefreshRequest request)

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

public Monitor updateMonitor(UpdateMonitorRequest request)

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

public Refresh updateRefresh(UpdateRefreshRequest request)

(Unimplemented) Update a refresh

impl

public DataQualityService impl()