DataQualityRule

class pyatlan.model.assets.DataQualityRule(*, typeName: str = 'DataQualityRule', attributes: DataQualityRule.Attributes = None, businessAttributes: Dict[str, Any] | None = None, createdBy: str | None = None, createTime: int | None = None, deleteHandler: str | None = None, guid: str = None, isIncomplete: bool | None = None, labels: List[str] | None = None, relationshipAttributes: RelationshipAttributes | Dict[str, Any] | None = None, status: EntityStatus | None = None, updatedBy: str | None = None, updateTime: int | None = None, version: int | None = None, classifications: List[AtlanTag] | None = None, classificationNames: List[str] | None = None, displayText: str | None = None, entityStatus: str | None = None, relationshipGuid: str | None = None, relationshipStatus: str | None = None, relationshipType: str | None = None, meaningNames: List[str] | None = None, meanings: List[Meaning] | None = None, customAttributes: Dict[str, Any] | None = None, scrubbed: bool | None = None, pendingTasks: List[str] | None = None, uniqueAttributes: Dict[str, Any] | None = None, appendRelationshipAttributes: Dict[str, Any] | None = None, removeRelationshipAttributes: Dict[str, Any] | None = None, addOrUpdateClassifications: List[AtlanTag] | None = None, removeClassifications: List[AtlanTag] | None = None, semantic: SaveSemantic | None = None, depth: int | None = None, immediateUpstream: List[LineageRef] | None = None, immediateDownstream: List[LineageRef] | None = None)[source]

Description

DQ_RULE_ALERT_PRIORITY: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Default priority level for alerts involving this rule.

DQ_RULE_BASE_COLUMN: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>

TBC

DQ_RULE_BASE_COLUMN_QUALIFIED_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Base column qualified name that attached to this rule.

DQ_RULE_BASE_DATASET: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>

TBC

DQ_RULE_BASE_DATASET_QUALIFIED_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Base dataset qualified name that attached to this rule.

DQ_RULE_CONFIG_ARGUMENTS: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Json string of the rule config that contains the rule definitions.

DQ_RULE_CUSTOM_SQL: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

SQL code for custom SQL rules.

DQ_RULE_CUSTOM_SQL_RETURN_TYPE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Type of result returned by the custom SQL (number of rows or numeric value).

DQ_RULE_DIMENSION: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Dimension of the data quality rule.

DQ_RULE_FAILED_ROWS_SQL: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

SQL query used to retrieve failed rows.

DQ_RULE_LATEST_METRIC_VALUE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Last result metrics value of the rule.

DQ_RULE_LATEST_METRIC_VALUE_COMPUTED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>

Time (epoch) at which the latest metric value was evaluated in the source.

DQ_RULE_LATEST_RESULT: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Latest result of the rule.

DQ_RULE_LATEST_RESULT_COMPUTED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>

Time (epoch) at which the latest rule result was evaluated.

DQ_RULE_LATEST_RESULT_FETCHED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>

Time (epoch) at which the latest rule result was fetched.

DQ_RULE_REFERENCE_COLUMNS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>

TBC

DQ_RULE_REFERENCE_COLUMN_QUALIFIED_NAMES: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

List of unique reference column’s qualified names related to this rule.

DQ_RULE_REFERENCE_DATASETS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>

TBC

DQ_RULE_REFERENCE_DATASET_QUALIFIED_NAMES: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

List of unique reference dataset’s qualified names related to this rule.

DQ_RULE_ROW_SCOPE_FILTERING_ENABLED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>

Whether row scope filtering is enabled for this data quality rule (true) or not (false).

DQ_RULE_SOURCE_SYNCED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>

Time (epoch) at which the rule synced to the source.

DQ_RULE_SOURCE_SYNC_ERROR_CODE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Error code in the case of state being “failure”.

DQ_RULE_SOURCE_SYNC_ERROR_MESSAGE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Error message in the case of state being “error”.

DQ_RULE_SOURCE_SYNC_RAW_ERROR: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Raw error message from the source.

DQ_RULE_SOURCE_SYNC_STATUS: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Latest sync status of the rule to the source.

DQ_RULE_STATUS: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Status of the rule.

DQ_RULE_TEMPLATE: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>

TBC

DQ_RULE_TEMPLATE_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>

Name of the rule template corresponding to the rule.