Data Quality

Anomalo

pyatlan.model.assets.core.anomalo.Anomalo(__pydantic_self__, **data: Any)

Bases: DataQuality

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

AnomaloCheck

pyatlan.model.assets.core.anomalo_check.AnomaloCheck(__pydantic_self__, **data: Any)

Bases: Anomalo

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ANOMALO_CHECK_ASSET: RelationField = RelationField('anomaloCheckAsset') class-attribute

TBC

ANOMALO_CHECK_CATEGORY_TYPE: KeywordField = KeywordField('anomaloCheckCategoryType', 'anomaloCheckCategoryType') class-attribute

Category type of the check in Anomalo

ANOMALO_CHECK_HISTORIC_RUN_STATUS: TextField = TextField('anomaloCheckHistoricRunStatus', 'anomaloCheckHistoricRunStatus') class-attribute

Historic run status of the check in Anomalo

ANOMALO_CHECK_IS_SYSTEM_ADDED: BooleanField = BooleanField('anomaloCheckIsSystemAdded', 'anomaloCheckIsSystemAdded') class-attribute

Flag to indicate if the check is an out of the box available check

ANOMALO_CHECK_LAST_RUN_COMPLETED_AT: NumericField = NumericField('anomaloCheckLastRunCompletedAt', 'anomaloCheckLastRunCompletedAt') class-attribute

Timestamp when the check was last run

ANOMALO_CHECK_LAST_RUN_EVALUATED_MESSAGE: TextField = TextField('anomaloCheckLastRunEvaluatedMessage', 'anomaloCheckLastRunEvaluatedMessage') class-attribute

Evaluated message of the latest check run.

ANOMALO_CHECK_LAST_RUN_URL: TextField = TextField('anomaloCheckLastRunUrl', 'anomaloCheckLastRunUrl') class-attribute

URL to the latest check run.

ANOMALO_CHECK_LINKED_ASSET_QUALIFIED_NAME: KeywordField = KeywordField('anomaloCheckLinkedAssetQualifiedName', 'anomaloCheckLinkedAssetQualifiedName') class-attribute

QualifiedName of the asset associated with the check

ANOMALO_CHECK_PRIORITY_LEVEL: KeywordField = KeywordField('anomaloCheckPriorityLevel', 'anomaloCheckPriorityLevel') class-attribute

Priority level of the check in Anomalo

ANOMALO_CHECK_STATUS: KeywordField = KeywordField('anomaloCheckStatus', 'anomaloCheckStatus') class-attribute

Status of the check in Anomalo

ANOMALO_CHECK_STATUS_IMAGE_URL: TextField = TextField('anomaloCheckStatusImageUrl', 'anomaloCheckStatusImageUrl') class-attribute

Image URL for the status of the check in Anomalo

ANOMALO_CHECK_TYPE: KeywordField = KeywordField('anomaloCheckType', 'anomaloCheckType') class-attribute

Type of check in Anomalo

DataQuality

pyatlan.model.assets.core.data_quality.DataQuality(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DQ_IS_PART_OF_CONTRACT: BooleanField = BooleanField('dqIsPartOfContract', 'dqIsPartOfContract') class-attribute

Whether this data quality is part of contract (true) or not (false).

DataQualityRule

pyatlan.model.assets.core.data_quality_rule.DataQualityRule(__pydantic_self__, **data: Any)

Bases: DataQuality

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DQ_RULE_ALERT_PRIORITY: KeywordField = KeywordField('dqRuleAlertPriority', 'dqRuleAlertPriority') class-attribute

Default priority level for alerts involving this rule.

DQ_RULE_BASE_COLUMN: RelationField = RelationField('dqRuleBaseColumn') class-attribute

TBC

DQ_RULE_BASE_COLUMN_QUALIFIED_NAME: KeywordField = KeywordField('dqRuleBaseColumnQualifiedName', 'dqRuleBaseColumnQualifiedName') class-attribute

Base column qualified name that attached to this rule.

DQ_RULE_BASE_DATASET: RelationField = RelationField('dqRuleBaseDataset') class-attribute

TBC

DQ_RULE_BASE_DATASET_QUALIFIED_NAME: KeywordField = KeywordField('dqRuleBaseDatasetQualifiedName', 'dqRuleBaseDatasetQualifiedName') class-attribute

Base dataset qualified name that attached to this rule.

DQ_RULE_CONFIG_ARGUMENTS: KeywordField = KeywordField('dqRuleConfigArguments', 'dqRuleConfigArguments') class-attribute

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

DQ_RULE_CUSTOM_SQL: KeywordField = KeywordField('dqRuleCustomSQL', 'dqRuleCustomSQL') class-attribute

SQL code for custom SQL rules.

DQ_RULE_CUSTOM_SQL_RETURN_TYPE: KeywordField = KeywordField('dqRuleCustomSQLReturnType', 'dqRuleCustomSQLReturnType') class-attribute

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

DQ_RULE_DIMENSION: KeywordField = KeywordField('dqRuleDimension', 'dqRuleDimension') class-attribute

Dimension of the data quality rule.

DQ_RULE_FAILED_ROWS_SQL: KeywordField = KeywordField('dqRuleFailedRowsSQL', 'dqRuleFailedRowsSQL') class-attribute

SQL query used to retrieve failed rows.

DQ_RULE_LATEST_METRIC_VALUE: KeywordField = KeywordField('dqRuleLatestMetricValue', 'dqRuleLatestMetricValue') class-attribute

Last result metrics value of the rule.

DQ_RULE_LATEST_METRIC_VALUE_COMPUTED_AT: NumericField = NumericField('dqRuleLatestMetricValueComputedAt', 'dqRuleLatestMetricValueComputedAt') class-attribute

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

DQ_RULE_LATEST_RESULT: KeywordField = KeywordField('dqRuleLatestResult', 'dqRuleLatestResult') class-attribute

Latest result of the rule.

DQ_RULE_LATEST_RESULT_COMPUTED_AT: NumericField = NumericField('dqRuleLatestResultComputedAt', 'dqRuleLatestResultComputedAt') class-attribute

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

DQ_RULE_LATEST_RESULT_FETCHED_AT: NumericField = NumericField('dqRuleLatestResultFetchedAt', 'dqRuleLatestResultFetchedAt') class-attribute

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

DQ_RULE_REFERENCE_COLUMNS: RelationField = RelationField('dqRuleReferenceColumns') class-attribute

TBC

DQ_RULE_REFERENCE_COLUMN_QUALIFIED_NAMES: KeywordField = KeywordField('dqRuleReferenceColumnQualifiedNames', 'dqRuleReferenceColumnQualifiedNames') class-attribute

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

DQ_RULE_REFERENCE_DATASETS: RelationField = RelationField('dqRuleReferenceDatasets') class-attribute

TBC

DQ_RULE_REFERENCE_DATASET_QUALIFIED_NAMES: KeywordField = KeywordField('dqRuleReferenceDatasetQualifiedNames', 'dqRuleReferenceDatasetQualifiedNames') class-attribute

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

DQ_RULE_ROW_SCOPE_FILTERING_ENABLED: BooleanField = BooleanField('dqRuleRowScopeFilteringEnabled', 'dqRuleRowScopeFilteringEnabled') class-attribute

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

DQ_RULE_SOURCE_SYNCED_AT: NumericField = NumericField('dqRuleSourceSyncedAt', 'dqRuleSourceSyncedAt') class-attribute

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

DQ_RULE_SOURCE_SYNC_ERROR_CODE: KeywordField = KeywordField('dqRuleSourceSyncErrorCode', 'dqRuleSourceSyncErrorCode') class-attribute

Error code in the case of state being "failure".

DQ_RULE_SOURCE_SYNC_ERROR_MESSAGE: KeywordField = KeywordField('dqRuleSourceSyncErrorMessage', 'dqRuleSourceSyncErrorMessage') class-attribute

Error message in the case of state being "error".

DQ_RULE_SOURCE_SYNC_RAW_ERROR: KeywordField = KeywordField('dqRuleSourceSyncRawError', 'dqRuleSourceSyncRawError') class-attribute

Raw error message from the source.

DQ_RULE_SOURCE_SYNC_STATUS: KeywordField = KeywordField('dqRuleSourceSyncStatus', 'dqRuleSourceSyncStatus') class-attribute

Latest sync status of the rule to the source.

DQ_RULE_STATUS: KeywordField = KeywordField('dqRuleStatus', 'dqRuleStatus') class-attribute

Status of the rule.

DQ_RULE_TEMPLATE: RelationField = RelationField('dqRuleTemplate') class-attribute

TBC

DQ_RULE_TEMPLATE_NAME: KeywordField = KeywordField('dqRuleTemplateName', 'dqRuleTemplateName') class-attribute

Name of the rule template corresponding to the rule.

DataQualityRuleTemplate

pyatlan.model.assets.core.data_quality_rule_template.DataQualityRuleTemplate(__pydantic_self__, **data: Any)

Bases: DataQuality

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DQ_RULES: RelationField = RelationField('dqRules') class-attribute

TBC

DQ_RULE_TEMPLATE_CONFIG: KeywordField = KeywordField('dqRuleTemplateConfig', 'dqRuleTemplateConfig') class-attribute

Rule config that will help render the form and define the rule.

DQ_RULE_TEMPLATE_DIMENSION: KeywordField = KeywordField('dqRuleTemplateDimension', 'dqRuleTemplateDimension') class-attribute

Name of the dimension the rule belongs to.

DQ_RULE_TEMPLATE_METRIC_VALUE_TYPE: KeywordField = KeywordField('dqRuleTemplateMetricValueType', 'dqRuleTemplateMetricValueType') class-attribute

Type of the metric value returned by the rule(absolute, percentage, time etc.).

MCIncident

pyatlan.model.assets.core.m_c_incident.MCIncident(__pydantic_self__, **data: Any)

Bases: MonteCarlo

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MC_INCIDENT_ASSETS: RelationField = RelationField('mcIncidentAssets') class-attribute

TBC

MC_INCIDENT_ID: KeywordField = KeywordField('mcIncidentId', 'mcIncidentId') class-attribute

Identifier of this incident, from Monte Carlo.

MC_INCIDENT_PRIORITY: KeywordField = KeywordField('mcIncidentPriority', 'mcIncidentPriority') class-attribute

Priority of this incident inherited from monitor.

MC_INCIDENT_SEVERITY: KeywordField = KeywordField('mcIncidentSeverity', 'mcIncidentSeverity') class-attribute

Severity of this incident.

MC_INCIDENT_STATE: KeywordField = KeywordField('mcIncidentState', 'mcIncidentState') class-attribute

State of this incident.

MC_INCIDENT_SUB_TYPES: KeywordField = KeywordField('mcIncidentSubTypes', 'mcIncidentSubTypes') class-attribute

Subtypes of this incident.

MC_INCIDENT_TYPE: KeywordField = KeywordField('mcIncidentType', 'mcIncidentType') class-attribute

Type of this incident.

MC_INCIDENT_WAREHOUSE: KeywordField = KeywordField('mcIncidentWarehouse', 'mcIncidentWarehouse') class-attribute

Name of this incident's warehouse.

MC_MONITOR: RelationField = RelationField('mcMonitor') class-attribute

TBC

MCMonitor

pyatlan.model.assets.core.m_c_monitor.MCMonitor(__pydantic_self__, **data: Any)

Bases: MonteCarlo

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MC_MONITOR_ALERT_CONDITION: TextField = TextField('mcMonitorAlertCondition', 'mcMonitorAlertCondition') class-attribute

Condition on which the monitor produces an alert.

MC_MONITOR_ALERT_COUNT: NumericField = NumericField('mcMonitorAlertCount', 'mcMonitorAlertCount') class-attribute

Number of alerts associated with this monitor.

MC_MONITOR_ASSETS: RelationField = RelationField('mcMonitorAssets') class-attribute

TBC

MC_MONITOR_BREACH_RATE: NumericField = NumericField('mcMonitorBreachRate', 'mcMonitorBreachRate') class-attribute

Rate at which this monitor is breached.

MC_MONITOR_ID: KeywordField = KeywordField('mcMonitorId', 'mcMonitorId') class-attribute

Unique identifier for this monitor, from Monte Carlo.

MC_MONITOR_INCIDENT_COUNT: NumericField = NumericField('mcMonitorIncidentCount', 'mcMonitorIncidentCount') class-attribute

Number of incidents associated with this monitor.

MC_MONITOR_IS_OOTB: BooleanField = BooleanField('mcMonitorIsOotb', 'mcMonitorIsOotb') class-attribute

Whether the monitor is OOTB or not

MC_MONITOR_NAMESPACE: KeywordTextField = KeywordTextField('mcMonitorNamespace', 'mcMonitorNamespace.keyword', 'mcMonitorNamespace') class-attribute

Namespace of this monitor.

MC_MONITOR_NOTIFICATION_CHANNELS: KeywordField = KeywordField('mcMonitorNotificationChannels', 'mcMonitorNotificationChannels') class-attribute

Channels through which notifications are sent for this monitor (e.g., email, slack, webhook).

MC_MONITOR_PRIORITY: KeywordField = KeywordField('mcMonitorPriority', 'mcMonitorPriority') class-attribute

Priority of this monitor.

MC_MONITOR_RULE_COMPARISONS: KeywordField = KeywordField('mcMonitorRuleComparisons', 'mcMonitorRuleComparisons') class-attribute

Comparison logic used for the rule.

MC_MONITOR_RULE_CUSTOM_SQL: TextField = TextField('mcMonitorRuleCustomSql', 'mcMonitorRuleCustomSql') class-attribute

SQL code for custom SQL rules.

MC_MONITOR_RULE_IS_SNOOZED: BooleanField = BooleanField('mcMonitorRuleIsSnoozed', 'mcMonitorRuleIsSnoozed') class-attribute

Whether the rule is currently snoozed (true) or not (false).

MC_MONITOR_RULE_NEXT_EXECUTION_TIME: NumericField = NumericField('mcMonitorRuleNextExecutionTime', 'mcMonitorRuleNextExecutionTime') class-attribute

Time at which the next execution of the rule should occur.

MC_MONITOR_RULE_PREVIOUS_EXECUTION_TIME: NumericField = NumericField('mcMonitorRulePreviousExecutionTime', 'mcMonitorRulePreviousExecutionTime') class-attribute

Time at which the previous execution of the rule occurred.

MC_MONITOR_RULE_SCHEDULE_CONFIG: KeywordField = KeywordField('mcMonitorRuleScheduleConfig', 'mcMonitorRuleScheduleConfig') class-attribute

Schedule details for the rule.

MC_MONITOR_RULE_SCHEDULE_CONFIG_HUMANIZED: TextField = TextField('mcMonitorRuleScheduleConfigHumanized', 'mcMonitorRuleScheduleConfigHumanized') class-attribute

Readable description of the schedule for the rule.

MC_MONITOR_RULE_TYPE: KeywordField = KeywordField('mcMonitorRuleType', 'mcMonitorRuleType') class-attribute

Type of rule for this monitor.

MC_MONITOR_SCHEDULE_TYPE: KeywordField = KeywordField('mcMonitorScheduleType', 'mcMonitorScheduleType') class-attribute

Type of schedule for this monitor, for example: fixed or dynamic.

MC_MONITOR_STATUS: KeywordField = KeywordField('mcMonitorStatus', 'mcMonitorStatus') class-attribute

Status of this monitor.

MC_MONITOR_TYPE: KeywordField = KeywordField('mcMonitorType', 'mcMonitorType') class-attribute

Type of this monitor, for example: field health (stats) or dimension tracking (categories).

MC_MONITOR_WAREHOUSE: KeywordField = KeywordField('mcMonitorWarehouse', 'mcMonitorWarehouse') class-attribute

Name of the warehouse for this monitor.

Metric

pyatlan.model.assets.core.metric.Metric(__pydantic_self__, **data: Any)

Bases: DataQuality

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ASSETS: RelationField = RelationField('assets') class-attribute

TBC

METRIC_DIMENSION_COLUMNS: RelationField = RelationField('metricDimensionColumns') class-attribute

TBC

METRIC_FILTERS: TextField = TextField('metricFilters', 'metricFilters') class-attribute

Filters to be applied to the metric query.

METRIC_SQL: TextField = TextField('metricSQL', 'metricSQL') class-attribute

SQL query used to compute the metric.

METRIC_TIMESTAMP_COLUMN: RelationField = RelationField('metricTimestampColumn') class-attribute

TBC

METRIC_TIME_GRAINS: TextField = TextField('metricTimeGrains', 'metricTimeGrains') class-attribute

List of time grains to be applied to the metric query.

METRIC_TYPE: KeywordField = KeywordField('metricType', 'metricType') class-attribute

Type of the metric.

MonteCarlo

pyatlan.model.assets.core.monte_carlo.MonteCarlo(__pydantic_self__, **data: Any)

Bases: DataQuality

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MC_ASSET_QUALIFIED_NAMES: KeywordField = KeywordField('mcAssetQualifiedNames', 'mcAssetQualifiedNames') class-attribute

List of unique names of assets that are part of this Monte Carlo asset.

MC_LABELS: KeywordField = KeywordField('mcLabels', 'mcLabels') class-attribute

List of labels for this Monte Carlo asset.

Soda

pyatlan.model.assets.core.soda.Soda(__pydantic_self__, **data: Any)

Bases: DataQuality

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

SodaCheck

pyatlan.model.assets.core.soda_check.SodaCheck(__pydantic_self__, **data: Any)

Bases: Soda

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

SODA_CHECK_ASSETS: RelationField = RelationField('sodaCheckAssets') class-attribute

TBC

SODA_CHECK_COLUMNS: RelationField = RelationField('sodaCheckColumns') class-attribute

TBC

SODA_CHECK_DEFINITION: TextField = TextField('sodaCheckDefinition', 'sodaCheckDefinition') class-attribute

Definition of the check in Soda.

SODA_CHECK_EVALUATION_STATUS: KeywordField = KeywordField('sodaCheckEvaluationStatus', 'sodaCheckEvaluationStatus') class-attribute

Status of the check in Soda.

SODA_CHECK_ID: KeywordField = KeywordField('sodaCheckId', 'sodaCheckId') class-attribute

Identifier of the check in Soda.

SODA_CHECK_INCIDENT_COUNT: NumericField = NumericField('sodaCheckIncidentCount', 'sodaCheckIncidentCount') class-attribute

SODA_CHECK_LAST_SCAN_AT: NumericField = NumericField('sodaCheckLastScanAt', 'sodaCheckLastScanAt') class-attribute

SODA_CHECK_LINKED_ASSET_QUALIFIED_NAME: KeywordField = KeywordField('sodaCheckLinkedAssetQualifiedName', 'sodaCheckLinkedAssetQualifiedName') class-attribute

QualifiedName of the asset associated with the check.