Package com.atlan.model.assets
Class DataQualityRule.DataQualityRuleBuilder<C extends DataQualityRule,B extends DataQualityRule.DataQualityRuleBuilder<C,B>>
java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.relations.Reference.ReferenceBuilder<C,B>
com.atlan.model.assets.Asset.AssetBuilder<C,B>
com.atlan.model.assets.DataQualityRule.DataQualityRuleBuilder<C,B>
- Enclosing class:
DataQualityRule
public abstract static class DataQualityRule.DataQualityRuleBuilder<C extends DataQualityRule,B extends DataQualityRule.DataQualityRuleBuilder<C,B>>
extends Asset.AssetBuilder<C,B>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected B
$fillValuesFrom
(C instance) abstract C
build()
dqIsPartOfContract
(Boolean dqIsPartOfContract) Whether this data quality is part of contract (true) or not (false).dqRuleAlertPriority
(DataQualityRuleAlertPriority dqRuleAlertPriority) Default priority level for alerts involving this rule.dqRuleBaseColumn
(IColumn dqRuleBaseColumn) Base column attached to this rule.dqRuleBaseColumnQualifiedName
(String dqRuleBaseColumnQualifiedName) Base column qualified name that attached to this rule.dqRuleBaseDataset
(IAsset dqRuleBaseDataset) Base dataset attached to this rule.dqRuleBaseDatasetQualifiedName
(String dqRuleBaseDatasetQualifiedName) Base dataset qualified name that attached to this rule.dqRuleConfigArguments
(DataQualityRuleConfigArguments dqRuleConfigArguments) Json string of the rule config that contains the rule definitions.dqRuleCustomSQL
(String dqRuleCustomSQL) SQL code for custom SQL rules.dqRuleDimension
(DataQualityDimension dqRuleDimension) Dimension of the data quality rule.dqRuleLatestMetricValue
(String dqRuleLatestMetricValue) Last result metrics value of the rule.dqRuleLatestMetricValueComputedAt
(Long dqRuleLatestMetricValueComputedAt) Time (epoch) at which the latest metric value was evaluated in the source.dqRuleLatestResult
(DataQualityResult dqRuleLatestResult) Latest result of the rule.dqRuleLatestResultComputedAt
(Long dqRuleLatestResultComputedAt) Time (epoch) at which the latest rule result was evaluated.dqRuleLatestResultFetchedAt
(Long dqRuleLatestResultFetchedAt) Time (epoch) at which the latest rule result was fetched.dqRuleReferenceColumn
(IColumn dqRuleReferenceColumn) dqRuleReferenceColumnQualifiedName
(String dqRuleReferenceColumnQualifiedName) dqRuleReferenceColumnQualifiedNames
(Collection<? extends String> dqRuleReferenceColumnQualifiedNames) dqRuleReferenceColumns
(Collection<? extends IColumn> dqRuleReferenceColumns) dqRuleReferenceDataset
(IAsset dqRuleReferenceDataset) dqRuleReferenceDatasetQualifiedName
(String dqRuleReferenceDatasetQualifiedName) dqRuleReferenceDatasetQualifiedNames
(Collection<? extends String> dqRuleReferenceDatasetQualifiedNames) dqRuleReferenceDatasets
(Collection<? extends IAsset> dqRuleReferenceDatasets) dqRuleRowScopeFilteringEnabled
(Boolean dqRuleRowScopeFilteringEnabled) Whether row scope filtering is enabled for this data quality rule (true) or not (false).dqRuleSourceSyncedAt
(Long dqRuleSourceSyncedAt) Time (epoch) at which the rule synced to the source.dqRuleSourceSyncErrorCode
(String dqRuleSourceSyncErrorCode) Error code in the case of state being "failure".dqRuleSourceSyncErrorMessage
(String dqRuleSourceSyncErrorMessage) Error message in the case of state being "error".dqRuleSourceSyncRawError
(String dqRuleSourceSyncRawError) Raw error message from the source.dqRuleSourceSyncStatus
(DataQualitySourceSyncStatus dqRuleSourceSyncStatus) Latest sync status of the rule to the source.dqRuleStatus
(DataQualityRuleStatus dqRuleStatus) Status of the rule.dqRuleTemplate
(IDataQualityRuleTemplate dqRuleTemplate) Template used to create this rule.dqRuleTemplateName
(String dqRuleTemplateName) Name of the rule template corresponding to the rule.inputToAirflowTask
(IAirflowTask inputToAirflowTask) inputToAirflowTasks
(Collection<? extends IAirflowTask> inputToAirflowTasks) inputToProcess
(ILineageProcess inputToProcess) inputToProcesses
(Collection<? extends ILineageProcess> inputToProcesses) inputToSparkJob
(ISparkJob inputToSparkJob) inputToSparkJobs
(Collection<? extends ISparkJob> inputToSparkJobs) modelImplementedAttribute
(IModelAttribute modelImplementedAttribute) modelImplementedAttributes
(Collection<? extends IModelAttribute> modelImplementedAttributes) modelImplementedEntities
(Collection<? extends IModelEntity> modelImplementedEntities) modelImplementedEntity
(IModelEntity modelImplementedEntity) outputFromAirflowTask
(IAirflowTask outputFromAirflowTask) outputFromAirflowTasks
(Collection<? extends IAirflowTask> outputFromAirflowTasks) outputFromProcess
(ILineageProcess outputFromProcess) outputFromProcesses
(Collection<? extends ILineageProcess> outputFromProcesses) outputFromSparkJob
(ISparkJob outputFromSparkJob) outputFromSparkJobs
(Collection<? extends ISparkJob> outputFromSparkJobs) protected abstract B
self()
toString()
Fixed typeName for DataQualityRules.Methods inherited from class com.atlan.model.assets.Asset.AssetBuilder
addStarredBy, adminGroup, adminGroups, adminRole, adminRoles, adminUser, adminUsers, announcementMessage, announcementTitle, announcementType, announcementUpdatedAt, announcementUpdatedBy, anomaloCheck, anomaloChecks, appendAssignedTerm, appendAtlanTag, appendAtlanTag, appendAtlanTags, appendAtlanTags, application, applicationField, applicationFieldQualifiedName, applicationQualifiedName, assetAnomaloAppliedCheckType, assetAnomaloAppliedCheckTypes, assetAnomaloCheckCount, assetAnomaloCheckStatuses, assetAnomaloDQStatus, assetAnomaloFailedCheckCount, assetAnomaloFailedCheckType, assetAnomaloFailedCheckTypes, assetAnomaloLastCheckRunAt, assetAnomaloSourceUrl, assetCoverImage, assetDbtAccountName, assetDbtAlias, assetDbtEnvironmentDbtVersion, assetDbtEnvironmentName, assetDbtJobLastRun, assetDbtJobLastRunArtifactS3Path, assetDbtJobLastRunArtifactsSaved, assetDbtJobLastRunCreatedAt, assetDbtJobLastRunDequedAt, assetDbtJobLastRunExecutedByThreadId, assetDbtJobLastRunGitBranch, assetDbtJobLastRunGitSha, assetDbtJobLastRunHasDocsGenerated, assetDbtJobLastRunHasSourcesGenerated, assetDbtJobLastRunNotificationsSent, assetDbtJobLastRunOwnerThreadId, assetDbtJobLastRunQueuedDuration, assetDbtJobLastRunQueuedDurationHumanized, assetDbtJobLastRunRunDuration, assetDbtJobLastRunRunDurationHumanized, assetDbtJobLastRunStartedAt, assetDbtJobLastRunStatusMessage, assetDbtJobLastRunTotalDuration, assetDbtJobLastRunTotalDurationHumanized, assetDbtJobLastRunUpdatedAt, assetDbtJobLastRunUrl, assetDbtJobName, assetDbtJobNextRun, assetDbtJobNextRunHumanized, assetDbtJobSchedule, assetDbtJobScheduleCronHumanized, assetDbtJobStatus, assetDbtMeta, assetDbtPackageName, assetDbtProjectName, assetDbtSemanticLayerProxyUrl, assetDbtSourceFreshnessCriteria, assetDbtTag, assetDbtTags, assetDbtTestStatus, assetDbtUniqueId, assetDbtWorkflowLastUpdated, assetDQFreshnessExpectation, assetDQFreshnessValue, assetDQResult, assetDQRowScopeFilterColumnQualifiedName, assetDQRuleAttachedDimension, assetDQRuleAttachedDimensions, assetDQRuleAttachedRuleType, assetDQRuleAttachedRuleTypes, assetDQRuleFailedCount, assetDQRuleFailedDimension, assetDQRuleFailedDimensions, assetDQRuleFailedRuleType, assetDQRuleFailedRuleTypes, assetDQRuleLastRunAt, assetDQRulePassedCount, assetDQRulePassedDimension, assetDQRulePassedDimensions, assetDQRulePassedRuleType, assetDQRulePassedRuleTypes, assetDQRuleResultTag, assetDQRuleResultTags, assetDQRuleTotalCount, assetDQScheduleCrontab, assetDQScheduleSourceSyncedAt, assetDQScheduleSourceSyncErrorCode, assetDQScheduleSourceSyncErrorMessage, assetDQScheduleSourceSyncRawError, assetDQScheduleSourceSyncStatus, assetDQScheduleTimeZone, assetDQScheduleType, assetIcon, assetInternalPopularityScore, assetMcAlertQualifiedName, assetMcAlertQualifiedNames, assetMcIncidentName, assetMcIncidentNames, assetMcIncidentPriorities, assetMcIncidentPriority, assetMcIncidentQualifiedName, assetMcIncidentQualifiedNames, assetMcIncidentSeverities, assetMcIncidentSeverity, assetMcIncidentState, assetMcIncidentStates, assetMcIncidentSubType, assetMcIncidentSubTypes, assetMcIncidentType, assetMcIncidentTypes, assetMcIsMonitored, assetMcLastSyncRunAt, assetMcMonitorName, assetMcMonitorNames, assetMcMonitorQualifiedName, assetMcMonitorQualifiedNames, assetMcMonitorScheduleType, assetMcMonitorScheduleTypes, assetMcMonitorStatus, assetMcMonitorStatuses, assetMcMonitorType, assetMcMonitorTypes, assetPoliciesCount, assetPolicyGUID, assetPolicyGUIDs, assetRedirectGUID, assetRedirectGUIDs, assetSodaCheckCount, assetSodaCheckStatuses, assetSodaDQStatus, assetSodaLastScanAt, assetSodaLastSyncRunAt, assetSodaSourceURL, assetSourceReadme, assetSpaceName, assetSpaceQualifiedName, assetTag, assetTags, assetThemeHex, assetUserDefinedType, assignedTerm, assignedTerms, atlanTag, atlanTagName, atlanTagNames, atlanTags, certificateStatus, certificateStatusMessage, certificateUpdatedAt, certificateUpdatedBy, clearAdminGroups, clearAdminRoles, clearAdminUsers, clearAnomaloChecks, clearAssetAnomaloAppliedCheckTypes, clearAssetAnomaloFailedCheckTypes, clearAssetDbtTags, clearAssetDQRuleAttachedDimensions, clearAssetDQRuleAttachedRuleTypes, clearAssetDQRuleFailedDimensions, clearAssetDQRuleFailedRuleTypes, clearAssetDQRulePassedDimensions, clearAssetDQRulePassedRuleTypes, clearAssetDQRuleResultTags, clearAssetMcAlertQualifiedNames, clearAssetMcIncidentNames, clearAssetMcIncidentPriorities, clearAssetMcIncidentQualifiedNames, clearAssetMcIncidentSeverities, clearAssetMcIncidentStates, clearAssetMcIncidentSubTypes, clearAssetMcIncidentTypes, clearAssetMcMonitorNames, clearAssetMcMonitorQualifiedNames, clearAssetMcMonitorScheduleTypes, clearAssetMcMonitorStatuses, clearAssetMcMonitorTypes, clearAssetPolicyGUIDs, clearAssetRedirectGUIDs, clearAssetTags, clearAssignedTerms, clearAtlanTagNames, clearAtlanTags, clearCustomMetadataSets, clearDomainGUIDs, clearDqBaseDatasetRules, clearDqReferenceDatasetRules, clearFiles, clearInputPortDataProducts, clearLinks, clearMcIncidents, clearMcMonitors, clearMeaningNames, clearMeanings, clearMetrics, clearNonCompliantAssetPolicyGUIDs, clearNullFields, clearOutputPortDataProducts, clearOutputProductGUIDs, clearOwnerGroups, clearOwnerUsers, clearPendingTasks, clearProductGUIDs, clearSchemaRegistrySubjects, clearSodaChecks, clearSourceQueryComputeCostRecords, clearSourceQueryComputeCosts, clearSourceReadExpensiveQueryRecords, clearSourceReadPopularQueryRecords, clearSourceReadRecentUserRecords, clearSourceReadRecentUsers, clearSourceReadSlowQueryRecords, clearSourceReadTopUserRecords, clearSourceReadTopUsers, clearStarredBy, clearStarredDetails, clearUserDefRelationshipFroms, clearUserDefRelationshipTos, clearViewerGroups, clearViewerUsers, connectionName, connectionQualifiedName, connectorName, connectorType, createdBy, createTime, customConnectorType, customMetadata, customMetadataSets, dataContractLatest, dataContractLatestCertified, dbtQualifiedName, deleteHandler, depth, description, displayName, domainGUID, domainGUIDs, dqBaseDatasetRule, dqBaseDatasetRules, dqReferenceDatasetRule, dqReferenceDatasetRules, file, files, hasContract, hasLineage, iconUrl, immediateDownstream, immediateUpstream, inputPortDataProduct, inputPortDataProducts, isAIGenerated, isDiscoverable, isEditable, isIncomplete, isPartial, lastRowChangedAt, lastSyncRun, lastSyncRunAt, lastSyncWorkflowName, lexicographicalSortOrder, link, links, mcIncident, mcIncidents, mcMonitor, mcMonitors, meaning, meaningName, meaningNames, meanings, metric, metrics, name, nonCompliantAssetPolicyGUID, nonCompliantAssetPolicyGUIDs, nullField, nullFields, outputPortDataProduct, outputPortDataProducts, outputProductGUID, outputProductGUIDs, ownerGroup, ownerGroups, ownerUser, ownerUsers, pendingTask, pendingTasks, popularityScore, productGUID, productGUIDs, qualifiedName, readme, removeAnnouncement, removeAssignedTerm, removeAssignedTerms, removeAtlanTag, removeAtlanTags, removeAtlanTags, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeUserDescription, sampleDataUrl, schemaRegistrySubject, schemaRegistrySubjects, sodaCheck, sodaChecks, sourceCostUnit, sourceCreatedAt, sourceCreatedBy, sourceEmbedURL, sourceLastReadAt, sourceOwners, sourceQueryComputeCost, sourceQueryComputeCostRecord, sourceQueryComputeCostRecords, sourceQueryComputeCosts, sourceReadCount, sourceReadExpensiveQueryRecord, sourceReadExpensiveQueryRecords, sourceReadPopularQueryRecord, sourceReadPopularQueryRecords, sourceReadQueryCost, sourceReadRecentUser, sourceReadRecentUserRecord, sourceReadRecentUserRecords, sourceReadRecentUsers, sourceReadSlowQueryRecord, sourceReadSlowQueryRecords, sourceReadTopUser, sourceReadTopUserRecord, sourceReadTopUserRecords, sourceReadTopUsers, sourceReadUserCount, sourceTotalCost, sourceUpdatedAt, sourceUpdatedBy, sourceURL, starredBy, starredCount, starredDetail, starredDetails, status, subType, tenantId, updatedBy, updateTime, userDefRelationshipFrom, userDefRelationshipFroms, userDefRelationshipTo, userDefRelationshipTos, userDescription, viewerGroup, viewerGroups, viewerUser, viewerUsers, viewScore
Methods inherited from class com.atlan.model.relations.Reference.ReferenceBuilder
clearCustomAttributes, clearLabels, completeObject, customAttribute, customAttributes, displayText, entityStatus, guid, label, labels, relationshipAttributes, relationshipGuid, relationshipStatus, relationshipType, semantic, uniqueAttributes
Methods inherited from class com.atlan.model.core.AtlanObject.AtlanObjectBuilder
rawJsonObject
-
Constructor Details
-
DataQualityRuleBuilder
public DataQualityRuleBuilder()
-
-
Method Details
-
$fillValuesFrom
- Overrides:
$fillValuesFrom
in classAsset.AssetBuilder<C extends DataQualityRule,
B extends DataQualityRule.DataQualityRuleBuilder<C, B>>
-
typeName
Fixed typeName for DataQualityRules.- Overrides:
typeName
in classReference.ReferenceBuilder<C extends DataQualityRule,
B extends DataQualityRule.DataQualityRuleBuilder<C, B>> - Returns:
this
.
-
dqIsPartOfContract
Whether this data quality is part of contract (true) or not (false).- Returns:
this
.
-
dqRuleAlertPriority
Default priority level for alerts involving this rule.- Returns:
this
.
-
dqRuleBaseColumn
Base column attached to this rule.- Returns:
this
.
-
dqRuleBaseColumnQualifiedName
Base column qualified name that attached to this rule.- Returns:
this
.
-
dqRuleBaseDataset
Base dataset attached to this rule.- Returns:
this
.
-
dqRuleBaseDatasetQualifiedName
Base dataset qualified name that attached to this rule.- Returns:
this
.
-
dqRuleConfigArguments
Json string of the rule config that contains the rule definitions.- Returns:
this
.
-
dqRuleCustomSQL
SQL code for custom SQL rules.- Returns:
this
.
-
dqRuleDimension
Dimension of the data quality rule.- Returns:
this
.
-
dqRuleLatestMetricValue
Last result metrics value of the rule.- Returns:
this
.
-
dqRuleLatestMetricValueComputedAt
Time (epoch) at which the latest metric value was evaluated in the source.- Returns:
this
.
-
dqRuleLatestResult
Latest result of the rule.- Returns:
this
.
-
dqRuleLatestResultComputedAt
Time (epoch) at which the latest rule result was evaluated.- Returns:
this
.
-
dqRuleLatestResultFetchedAt
Time (epoch) at which the latest rule result was fetched.- Returns:
this
.
-
dqRuleReferenceColumnQualifiedName
-
dqRuleReferenceColumnQualifiedNames
public B dqRuleReferenceColumnQualifiedNames(Collection<? extends String> dqRuleReferenceColumnQualifiedNames) -
clearDqRuleReferenceColumnQualifiedNames
-
dqRuleReferenceColumn
-
dqRuleReferenceColumns
-
clearDqRuleReferenceColumns
-
dqRuleReferenceDatasetQualifiedName
-
dqRuleReferenceDatasetQualifiedNames
public B dqRuleReferenceDatasetQualifiedNames(Collection<? extends String> dqRuleReferenceDatasetQualifiedNames) -
clearDqRuleReferenceDatasetQualifiedNames
-
dqRuleReferenceDataset
-
dqRuleReferenceDatasets
-
clearDqRuleReferenceDatasets
-
dqRuleRowScopeFilteringEnabled
Whether row scope filtering is enabled for this data quality rule (true) or not (false).- Returns:
this
.
-
dqRuleSourceSyncErrorCode
Error code in the case of state being "failure".- Returns:
this
.
-
dqRuleSourceSyncErrorMessage
Error message in the case of state being "error".- Returns:
this
.
-
dqRuleSourceSyncRawError
Raw error message from the source.- Returns:
this
.
-
dqRuleSourceSyncStatus
Latest sync status of the rule to the source.- Returns:
this
.
-
dqRuleSourceSyncedAt
Time (epoch) at which the rule synced to the source.- Returns:
this
.
-
dqRuleStatus
Status of the rule.- Returns:
this
.
-
dqRuleTemplate
Template used to create this rule.- Returns:
this
.
-
dqRuleTemplateName
Name of the rule template corresponding to the rule.- Returns:
this
.
-
inputToAirflowTask
-
inputToAirflowTasks
-
clearInputToAirflowTasks
-
inputToProcess
-
inputToProcesses
-
clearInputToProcesses
-
inputToSparkJob
-
inputToSparkJobs
-
clearInputToSparkJobs
-
modelImplementedAttribute
-
modelImplementedAttributes
public B modelImplementedAttributes(Collection<? extends IModelAttribute> modelImplementedAttributes) -
clearModelImplementedAttributes
-
modelImplementedEntity
-
modelImplementedEntities
-
clearModelImplementedEntities
-
outputFromAirflowTask
-
outputFromAirflowTasks
-
clearOutputFromAirflowTasks
-
outputFromProcess
-
outputFromProcesses
-
clearOutputFromProcesses
-
outputFromSparkJob
-
outputFromSparkJobs
-
clearOutputFromSparkJobs
-
self
- Specified by:
self
in classAsset.AssetBuilder<C extends DataQualityRule,
B extends DataQualityRule.DataQualityRuleBuilder<C, B>>
-
build
- Specified by:
build
in classAsset.AssetBuilder<C extends DataQualityRule,
B extends DataQualityRule.DataQualityRuleBuilder<C, B>>
-
toString
- Overrides:
toString
in classAsset.AssetBuilder<C extends DataQualityRule,
B extends DataQualityRule.DataQualityRuleBuilder<C, B>>
-