CheckDefinitionYaml
CheckDefinitionSpec
Custom data quality check specification. Provides the custom check configuration which is a pair of a sensor name and a rule name.
The structure of this object is described below
| Property name | Description | Data type | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
| sensor_name | Sensor name. It is a folder name inside the user's home 'sensors' folder or the DQOps Home (DQOps distribution) home/sensors folder. Sample sensor name: table/volume/row_count. | string | |||
| rule_name | Rule name used for the check. It is a path to a custom rule python module that starts at the user's home 'rules' folder. The path should not end with the .py file extension. Sample rule: myrules/my_custom_rule. | string | |||
| help_text | Help text that describes the data quality check. | string |
CheckDefinitionYaml
Custom check specification that describes a pair of a sensor name and rule name.
The structure of this object is described below
| Property name | Description | Data type | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
| api_version | string | ||||
| kind | enum | default_schedules settings default_notifications rule sensor source check dashboards default_checks table provider_sensor file_index |
|||
| spec | CheckDefinitionSpec |