Quality Monitor

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.qualitymonitorv2 module.

class databricks.sdk.service.qualitymonitorv2.AnomalyDetectionConfig(excluded_table_full_names: 'Optional[List[str]]' = None, last_run_id: 'Optional[str]' = None, latest_run_status: 'Optional[AnomalyDetectionRunStatus]' = None)

excluded_table_full_names: List[str] | None = None

List of fully qualified table names to exclude from anomaly detection.

last_run_id: str | None = None

Run id of the last run of the workflow

latest_run_status: AnomalyDetectionRunStatus | None = None

The status of the last run of the workflow.

as_dict() → dict

Serializes the AnomalyDetectionConfig into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AnomalyDetectionConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AnomalyDetectionConfig

Deserializes the AnomalyDetectionConfig from a dictionary.

class databricks.sdk.service.qualitymonitorv2.AnomalyDetectionRunStatus

Status of Anomaly Detection Job Run

ANOMALY_DETECTION_RUN_STATUS_CANCELED = "ANOMALY_DETECTION_RUN_STATUS_CANCELED"

ANOMALY_DETECTION_RUN_STATUS_FAILED = "ANOMALY_DETECTION_RUN_STATUS_FAILED"

ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED = "ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED"

ANOMALY_DETECTION_RUN_STATUS_PENDING = "ANOMALY_DETECTION_RUN_STATUS_PENDING"

ANOMALY_DETECTION_RUN_STATUS_RUNNING = "ANOMALY_DETECTION_RUN_STATUS_RUNNING"

ANOMALY_DETECTION_RUN_STATUS_SUCCESS = "ANOMALY_DETECTION_RUN_STATUS_SUCCESS"

ANOMALY_DETECTION_RUN_STATUS_UNKNOWN = "ANOMALY_DETECTION_RUN_STATUS_UNKNOWN"

ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR = "ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR"

class databricks.sdk.service.qualitymonitorv2.ListQualityMonitorResponse(next_page_token: 'Optional[str]' = None, quality_monitors: 'Optional[List[QualityMonitor]]' = None)

next_page_token: str | None = None

quality_monitors: List[QualityMonitor] | None = None

as_dict() → dict

Serializes the ListQualityMonitorResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListQualityMonitorResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListQualityMonitorResponse

Deserializes the ListQualityMonitorResponse from a dictionary.

class databricks.sdk.service.qualitymonitorv2.PercentNullValidityCheck(column_names: 'Optional[List[str]]' = None, upper_bound: 'Optional[float]' = None)

column_names: List[str] | None = None

List of column names to check for null percentage

upper_bound: float | None = None

Optional upper bound; we should use auto determined bounds for now

as_dict() → dict

Serializes the PercentNullValidityCheck into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the PercentNullValidityCheck into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → PercentNullValidityCheck

Deserializes the PercentNullValidityCheck from a dictionary.

class databricks.sdk.service.qualitymonitorv2.QualityMonitor(object_type: 'str', object_id: 'str', anomaly_detection_config: 'Optional[AnomalyDetectionConfig]' = None, validity_check_configurations: 'Optional[List[ValidityCheckConfiguration]]' = None)

object_type: str

The type of the monitored object. Can be one of the following: schema.

object_id: str

The uuid of the request object. For example, schema id.

anomaly_detection_config: AnomalyDetectionConfig | None = None

validity_check_configurations: List[ValidityCheckConfiguration] | None = None

Validity check configurations for anomaly detection.

as_dict() → dict

Serializes the QualityMonitor into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the QualityMonitor into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → QualityMonitor

Deserializes the QualityMonitor from a dictionary.

class databricks.sdk.service.qualitymonitorv2.RangeValidityCheck(column_names: 'Optional[List[str]]' = None, lower_bound: 'Optional[float]' = None, upper_bound: 'Optional[float]' = None)

column_names: List[str] | None = None

List of column names to check for range validity

lower_bound: float | None = None

Lower bound for the range

upper_bound: float | None = None

Upper bound for the range

as_dict() → dict

Serializes the RangeValidityCheck into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the RangeValidityCheck into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → RangeValidityCheck

Deserializes the RangeValidityCheck from a dictionary.

class databricks.sdk.service.qualitymonitorv2.UniquenessValidityCheck(column_names: 'Optional[List[str]]' = None)

column_names: List[str] | None = None

List of column names to check for uniqueness

as_dict() → dict

Serializes the UniquenessValidityCheck into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UniquenessValidityCheck into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UniquenessValidityCheck

Deserializes the UniquenessValidityCheck from a dictionary.

class databricks.sdk.service.qualitymonitorv2.ValidityCheckConfiguration(name: 'Optional[str]' = None, percent_null_validity_check: 'Optional[PercentNullValidityCheck]' = None, range_validity_check: 'Optional[RangeValidityCheck]' = None, uniqueness_validity_check: 'Optional[UniquenessValidityCheck]' = None)

name: str | None = None

Can be set by system. Does not need to be user facing.

percent_null_validity_check: PercentNullValidityCheck | None = None

range_validity_check: RangeValidityCheck | None = None

uniqueness_validity_check: UniquenessValidityCheck | None = None

as_dict() → dict

Serializes the ValidityCheckConfiguration into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ValidityCheckConfiguration into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ValidityCheckConfiguration

Deserializes the ValidityCheckConfiguration from a dictionary.