Package com.atlan.model.assets

Class DataQualityRule

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.relations.Reference

com.atlan.model.assets.Asset

com.atlan.model.assets.DataQualityRule

All Implemented Interfaces:

IAsset, ICatalog, IDataQuality, IDataQualityRule, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2")
public class DataQualityRule
extends Asset
implements IDataQualityRule, IDataQuality, ICatalog, IAsset, IReferenceable

Class to define a rule for the given asset in Atlan.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataQualityRule.DataQualityRuleBuilder<C extends DataQualityRule,B extends DataQualityRule.DataQualityRuleBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset

Asset.AssetBuilder<C extends Asset,B extends Asset.AssetBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference

Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>, Reference.SaveSemantic

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Fields inherited from interface com.atlan.model.assets.IAsset

ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_AI_ALIAS, ASSET_AI_GENERATED_DESCRIPTION, ASSET_AI_GENERATED_DESCRIPTION_CONFIDENCE, ASSET_AI_GENERATED_DESCRIPTION_REASONING, ASSET_ANNOUNCEMENT_EXPIRED_AT, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_DQ_FRESHNESS_EXPECTATION, ASSET_DQ_FRESHNESS_VALUE, ASSET_DQ_MANUAL_RUN_STATUS, ASSET_DQ_RESULT, ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME, ASSET_DQ_RULE_ATTACHED_DIMENSIONS, ASSET_DQ_RULE_ATTACHED_RULE_TYPES, ASSET_DQ_RULE_FAILED_COUNT, ASSET_DQ_RULE_FAILED_DIMENSIONS, ASSET_DQ_RULE_FAILED_RULE_TYPES, ASSET_DQ_RULE_LAST_RUN_AT, ASSET_DQ_RULE_PASSED_COUNT, ASSET_DQ_RULE_PASSED_DIMENSIONS, ASSET_DQ_RULE_PASSED_RULE_TYPES, ASSET_DQ_RULE_RESULT_TAGS, ASSET_DQ_RULE_TOTAL_COUNT, ASSET_DQ_SCHEDULE_CRONTAB, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR, ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS, ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT, ASSET_DQ_SCHEDULE_TIME_ZONE, ASSET_DQ_SCHEDULE_TYPE, ASSET_EXTERNAL_DQ_METADATA_DETAILS, ASSET_GCP_DATAPLEX_ASPECT_FIELD_LIST, ASSET_GCP_DATAPLEX_ASPECT_LIST, ASSET_GCP_DATAPLEX_METADATA_DETAILS, ASSET_HAS_AI_README, ASSET_ICON, ASSET_IMMUTA_REQUEST_TYPE, ASSET_IMMUTA_REQUEST_URL, ASSET_INTERNAL_POPULARITY_SCORE, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SMUS_METADATA_FORM_DETAILS, ASSET_SMUS_METADATA_FORM_KEY_VALUE_DETAILS, ASSET_SMUS_METADATA_FORM_NAMES, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_SOURCE_ID, ASSET_SOURCE_README, ASSET_SPACE_NAME, ASSET_SPACE_QUALIFIED_NAME, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, DQ_BASE_DATASET_RULES, DQ_REFERENCE_DATASET_RULES, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERS

Fields inherited from interface com.atlan.model.assets.ICatalog

CATALOG_DATASET_GUID, INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ATTRIBUTES, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS, PARTIAL_CHILD_FIELDS, PARTIAL_CHILD_OBJECTS

Fields inherited from interface com.atlan.model.assets.IDataQuality

DQ_IS_PART_OF_CONTRACT

Fields inherited from interface com.atlan.model.assets.IDataQualityRule

DQ_RULE_AD_STATUS, DQ_RULE_ALERT_PRIORITY, DQ_RULE_BASE_COLUMN, DQ_RULE_BASE_COLUMN_QUALIFIED_NAME, DQ_RULE_BASE_DATASET, DQ_RULE_BASE_DATASET_QUALIFIED_NAME, DQ_RULE_CONFIG_ARGUMENTS, DQ_RULE_CUSTOM_SQL, DQ_RULE_CUSTOM_SQL_RETURN_TYPE, DQ_RULE_DIMENSION, DQ_RULE_FAILED_ROWS_SQL, DQ_RULE_LATEST_METRIC_VALUE, DQ_RULE_LATEST_METRIC_VALUE_COMPUTED_AT, DQ_RULE_LATEST_RESULT, DQ_RULE_LATEST_RESULT_COMPUTED_AT, DQ_RULE_LATEST_RESULT_DETAILS, DQ_RULE_LATEST_RESULT_FETCHED_AT, DQ_RULE_REFERENCE_COLUMN_QUALIFIED_NAMES, DQ_RULE_REFERENCE_COLUMNS, DQ_RULE_REFERENCE_DATASET_QUALIFIED_NAMES, DQ_RULE_REFERENCE_DATASETS, DQ_RULE_ROW_SCOPE_FILTERING_ENABLED, DQ_RULE_SOURCE_SYNC_ERROR_CODE, DQ_RULE_SOURCE_SYNC_ERROR_MESSAGE, DQ_RULE_SOURCE_SYNC_RAW_ERROR, DQ_RULE_SOURCE_SYNC_STATUS, DQ_RULE_SOURCE_SYNCED_AT, DQ_RULE_STATUS, DQ_RULE_TEMPLATE, DQ_RULE_TEMPLATE_NAME

Fields inherited from interface com.atlan.model.assets.IReferenceable

ASSIGNED_TERMS, ATLAN_TAGS, CREATE_TIME, CREATED_BY, CUSTOM_ATTRIBUTES, GUID, PROPAGATED_ATLAN_TAGS, STATUS, SUPER_TYPE_NAMES, UPDATE_TIME, UPDATED_BY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataQualityRule(DataQualityRule.DataQualityRuleBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static DataQualityRule.DataQualityRuleBuilder<?,?>	_internal()
static DataQualityRule	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List)
static DataQualityRule	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
static DataQualityRule	appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static DataQualityRule	get(AtlanClient client, String id)	Retrieves a DataQualityRule by one of its identifiers, complete with all of its relationships.
static DataQualityRule	get(AtlanClient client, String id, boolean includeAllRelationships)	Retrieves a DataQualityRule by one of its identifiers, optionally complete with all of its relationships.
static DataQualityRule	get(AtlanClient client, String id, Collection<AtlanField> attributes)	Retrieves a DataQualityRule by one of its identifiers, with only the requested attributes (and relationships).
static DataQualityRule	get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)	Retrieves a DataQualityRule by one of its identifiers, with only the requested attributes (and relationships).
String	getCatalogDatasetGuid()	Unique identifier of the dataset this asset belongs to.
Boolean	getDqIsPartOfContract()	Whether this data quality is part of contract (true) or not (false).
DataQualityRuleADStatus	getDqRuleADStatus()	Anomaly detection lifecycle status for this rule.
DataQualityRuleAlertPriority	getDqRuleAlertPriority()	Default priority level for alerts involving this rule.
IColumn	getDqRuleBaseColumn()	Base column attached to this rule.
String	getDqRuleBaseColumnQualifiedName()	Base column qualified name that attached to this rule.
IAsset	getDqRuleBaseDataset()	Base dataset attached to this rule.
String	getDqRuleBaseDatasetQualifiedName()	Base dataset qualified name that attached to this rule.
DataQualityRuleConfigArguments	getDqRuleConfigArguments()	Json string of the rule config that contains the rule definitions.
String	getDqRuleCustomSQL()	SQL code for custom SQL rules.
DataQualityRuleCustomSQLReturnType	getDqRuleCustomSQLReturnType()	Type of result returned by the custom SQL (number of rows or numeric value).
DataQualityDimension	getDqRuleDimension()	Dimension of the data quality rule.
String	getDqRuleFailedRowsSQL()	SQL query used to retrieve failed rows.
String	getDqRuleLatestMetricValue()	Last result metrics value of the rule.
Long	getDqRuleLatestMetricValueComputedAt()	Time (epoch) at which the latest metric value was evaluated in the source.
DataQualityResult	getDqRuleLatestResult()	Latest result of the rule.
Long	getDqRuleLatestResultComputedAt()	Time (epoch) at which the latest rule result was evaluated.
String	getDqRuleLatestResultDetails()	JSON string with anomaly detection result details (forecast, upper_bound, lower_bound, is_anomaly) from Snowflake AD.
Long	getDqRuleLatestResultFetchedAt()	Time (epoch) at which the latest rule result was fetched.
SortedSet<String>	getDqRuleReferenceColumnQualifiedNames()	List of unique reference column's qualified names related to this rule.
SortedSet<IColumn>	getDqRuleReferenceColumns()	Columns referenced in this rule.
SortedSet<String>	getDqRuleReferenceDatasetQualifiedNames()	List of unique reference dataset's qualified names related to this rule.
SortedSet<IAsset>	getDqRuleReferenceDatasets()	Datasets referenced in this rule.
Boolean	getDqRuleRowScopeFilteringEnabled()	Whether row scope filtering is enabled for this data quality rule (true) or not (false).
Long	getDqRuleSourceSyncedAt()	Time (epoch) at which the rule synced to the source.
String	getDqRuleSourceSyncErrorCode()	Error code in the case of state being "failure".
String	getDqRuleSourceSyncErrorMessage()	Error message in the case of state being "error".
String	getDqRuleSourceSyncRawError()	Raw error message from the source.
DataQualitySourceSyncStatus	getDqRuleSourceSyncStatus()	Latest sync status of the rule to the source.
DataQualityRuleStatus	getDqRuleStatus()	Status of the rule.
IDataQualityRuleTemplate	getDqRuleTemplate()	Template used to create this rule.
String	getDqRuleTemplateName()	Name of the rule template corresponding to the rule.
SortedSet<IAirflowTask>	getInputToAirflowTasks()	Tasks to which this asset provides input.
SortedSet<ILineageProcess>	getInputToProcesses()	Processes to which this asset provides input.
SortedSet<ISparkJob>	getInputToSparkJobs()	TBC
SortedSet<IModelAttribute>	getModelImplementedAttributes()	Attributes implemented by this asset.
SortedSet<IModelEntity>	getModelImplementedEntities()	Entities implemented by this asset.
SortedSet<IAirflowTask>	getOutputFromAirflowTasks()	Tasks from which this asset is output.
SortedSet<ILineageProcess>	getOutputFromProcesses()	Processes from which this asset is produced as output.
SortedSet<ISparkJob>	getOutputFromSparkJobs()	TBC
SortedSet<IPartialField>	getPartialChildFields()	Partial fields contained in the asset.
SortedSet<IPartialObject>	getPartialChildObjects()	Partial objects contained in the asset.
String	getTypeName()	Fixed typeName for DataQualityRules.
int	hashCode()
static DataQualityRule	refByGuid(String guid)	Reference to a DataQualityRule by GUID.
static DataQualityRule	refByGuid(String guid, Reference.SaveSemantic semantic)	Reference to a DataQualityRule by GUID.
static DataQualityRule	refByQualifiedName(String qualifiedName)	Reference to a DataQualityRule by qualifiedName.
static DataQualityRule	refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)	Reference to a DataQualityRule by qualifiedName.
static DataQualityRule	removeAnnouncement(AtlanClient client, String qualifiedName, String name)	Remove the announcement from a DataQualityRule.
static void	removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)	Deprecated. see Asset.AssetBuilder.removeAtlanTag(String)
static DataQualityRule	removeCertificate(AtlanClient client, String qualifiedName, String name)	Remove the certificate from a DataQualityRule.
static DataQualityRule	removeDescription(AtlanClient client, String qualifiedName, String name)	Remove the system description from a DataQualityRule.
static DataQualityRule	removeOwners(AtlanClient client, String qualifiedName, String name)	Remove the owners from a DataQualityRule.
static DataQualityRule	removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
static DataQualityRule	removeUserDescription(AtlanClient client, String qualifiedName, String name)	Remove the user's description from a DataQualityRule.
static DataQualityRule	replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)	Replace the terms linked to the DataQualityRule.
static boolean	restore(AtlanClient client, String qualifiedName)	Restore the archived (soft-deleted) DataQualityRule to active.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client)	Start a fluent search that will return all DataQualityRule assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client, boolean includeArchived)	Start a fluent search that will return all DataQualityRule assets.
DataQualityRule.DataQualityRuleBuilder<?,?>	toBuilder()
String	toString()
DataQualityRule	trimToReference()	Builds the minimal object necessary to create a relationship to a DataQualityRule, from a potentially more-complete DataQualityRule object.
DataQualityRule.DataQualityRuleBuilder<?,?>	trimToRequired()	Builds the minimal object necessary to apply an update to a DataQualityRule, from a potentially more-complete DataQualityRule object.
static DataQualityRule	updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)	Update the announcement on a DataQualityRule.
static DataQualityRule	updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)	Update the certificate on a DataQualityRule.
static DataQualityRule.DataQualityRuleBuilder<?,?>	updater(String qualifiedName, String name)	Builds the minimal object necessary to update a DataQualityRule.

Methods inherited from class com.atlan.model.assets.Asset

addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM

Methods inherited from class com.atlan.model.relations.Reference

builder, by, compareTo, getAddedRelationshipAttributes, getCompleteObject, getCustomAttributes, getDisplayText, getDocId, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getRemovedRelationshipAttributes, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequired

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlan.model.search.AuditDetail

getRawJsonObject, setRawJsonObject

Methods inherited from interface com.atlan.model.assets.IAsset

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.ICatalog

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IDataQuality

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IDataQualityRule

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IReferenceable

getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

DataQualityRule

protected DataQualityRule(DataQualityRule.DataQualityRuleBuilder<?,?> b)

Method Details

trimToReference

public DataQualityRule trimToReference()
                                throws InvalidRequestException

Builds the minimal object necessary to create a relationship to a DataQualityRule, from a potentially more-complete DataQualityRule object.

Overrides:

trimToReference in class Asset

Returns:

the minimal object necessary to relate to the DataQualityRule

Throws:

InvalidRequestException - if any of the minimal set of required properties for a DataQualityRule relationship are not found in the initial object

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)

Start a fluent search that will return all DataQualityRule assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) DataQualityRule assets will be included.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the assets

Returns:

a fluent search that includes all DataQualityRule assets

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client,
 boolean includeArchived)

Start a fluent search that will return all DataQualityRule assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the assets

includeArchived - when true, archived (soft-deleted) DataQualityRules will be included

Returns:

a fluent search that includes all DataQualityRule assets

refByGuid

public static DataQualityRule refByGuid(String guid)

Reference to a DataQualityRule by GUID. Use this to create a relationship to this DataQualityRule, where the relationship should be replaced.

Parameters:

guid - the GUID of the DataQualityRule to reference

Returns:

reference to a DataQualityRule that can be used for defining a relationship to a DataQualityRule

refByGuid

public static DataQualityRule refByGuid(String guid,
 Reference.SaveSemantic semantic)

Reference to a DataQualityRule by GUID. Use this to create a relationship to this DataQualityRule, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

guid - the GUID of the DataQualityRule to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a DataQualityRule that can be used for defining a relationship to a DataQualityRule

refByQualifiedName

public static DataQualityRule refByQualifiedName(String qualifiedName)

Reference to a DataQualityRule by qualifiedName. Use this to create a relationship to this DataQualityRule, where the relationship should be replaced.

Parameters:

qualifiedName - the qualifiedName of the DataQualityRule to reference

Returns:

reference to a DataQualityRule that can be used for defining a relationship to a DataQualityRule

refByQualifiedName

public static DataQualityRule refByQualifiedName(String qualifiedName,
 Reference.SaveSemantic semantic)

Reference to a DataQualityRule by qualifiedName. Use this to create a relationship to this DataQualityRule, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

qualifiedName - the qualifiedName of the DataQualityRule to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a DataQualityRule that can be used for defining a relationship to a DataQualityRule

get

public static DataQualityRule get(AtlanClient client,
 String id)
                           throws AtlanException

Retrieves a DataQualityRule by one of its identifiers, complete with all of its relationships.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the DataQualityRule to retrieve, either its GUID or its full qualifiedName

Returns:

the requested full DataQualityRule, complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the DataQualityRule does not exist or the provided GUID is not a DataQualityRule

get

public static DataQualityRule get(AtlanClient client,
 String id,
 boolean includeAllRelationships)
                           throws AtlanException

Retrieves a DataQualityRule by one of its identifiers, optionally complete with all of its relationships.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the DataQualityRule to retrieve, either its GUID or its full qualifiedName

includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved

Returns:

the requested full DataQualityRule, optionally complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the DataQualityRule does not exist or the provided GUID is not a DataQualityRule

get

public static DataQualityRule get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes)
                           throws AtlanException

Retrieves a DataQualityRule by one of its identifiers, with only the requested attributes (and relationships).

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the DataQualityRule to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the DataQualityRule, including any relationships

Returns:

the requested DataQualityRule, with only its minimal information and the requested attributes (and relationships)

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the DataQualityRule does not exist or the provided GUID is not a DataQualityRule

get

public static DataQualityRule get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes,
 Collection<AtlanField> attributesOnRelated)
                           throws AtlanException

Retrieves a DataQualityRule by one of its identifiers, with only the requested attributes (and relationships).

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the asset

id - of the DataQualityRule to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the DataQualityRule, including any relationships

attributesOnRelated - to retrieve on each relationship retrieved for the DataQualityRule

Returns:

the requested DataQualityRule, with only its minimal information and the requested attributes (and relationships)

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the DataQualityRule does not exist or the provided GUID is not a DataQualityRule

restore

public static boolean restore(AtlanClient client,
 String qualifiedName)
                       throws AtlanException

Restore the archived (soft-deleted) DataQualityRule to active.

Parameters:

client - connectivity to the Atlan tenant on which to restore the asset

qualifiedName - for the DataQualityRule

Returns:

true if the DataQualityRule is now active, and false otherwise

Throws:

AtlanException - on any API problems

updater

public static DataQualityRule.DataQualityRuleBuilder<?,?> updater(String qualifiedName,
 String name)

Builds the minimal object necessary to update a DataQualityRule.

Parameters:

qualifiedName - of the DataQualityRule

name - of the DataQualityRule

Returns:

the minimal request necessary to update the DataQualityRule, as a builder

trimToRequired

public DataQualityRule.DataQualityRuleBuilder<?,?> trimToRequired()
                                                           throws InvalidRequestException

Builds the minimal object necessary to apply an update to a DataQualityRule, from a potentially more-complete DataQualityRule object.

Overrides:

trimToRequired in class Asset

Returns:

the minimal object necessary to update the DataQualityRule, as a builder

Throws:

InvalidRequestException - if any of the minimal set of required fields for a DataQualityRule are not present in the initial object

removeDescription

public static DataQualityRule removeDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                         throws AtlanException

Remove the system description from a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the DataQualityRule

name - of the DataQualityRule

Returns:

the updated DataQualityRule, or null if the removal failed

Throws:

AtlanException - on any API problems

removeUserDescription

public static DataQualityRule removeUserDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                             throws AtlanException

Remove the user's description from a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the DataQualityRule

name - of the DataQualityRule

Returns:

the updated DataQualityRule, or null if the removal failed

Throws:

AtlanException - on any API problems

removeOwners

public static DataQualityRule removeOwners(AtlanClient client,
 String qualifiedName,
 String name)
                                    throws AtlanException

Remove the owners from a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant from which to remove the DataQualityRule's owners

qualifiedName - of the DataQualityRule

name - of the DataQualityRule

Returns:

the updated DataQualityRule, or null if the removal failed

Throws:

AtlanException - on any API problems

updateCertificate

public static DataQualityRule updateCertificate(AtlanClient client,
 String qualifiedName,
 CertificateStatus certificate,
 String message)
                                         throws AtlanException

Update the certificate on a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant on which to update the DataQualityRule's certificate

qualifiedName - of the DataQualityRule

certificate - to use

message - (optional) message, or null if no message

Returns:

the updated DataQualityRule, or null if the update failed

Throws:

AtlanException - on any API problems

removeCertificate

public static DataQualityRule removeCertificate(AtlanClient client,
 String qualifiedName,
 String name)
                                         throws AtlanException

Remove the certificate from a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant from which to remove the DataQualityRule's certificate

qualifiedName - of the DataQualityRule

name - of the DataQualityRule

Returns:

the updated DataQualityRule, or null if the removal failed

Throws:

AtlanException - on any API problems

updateAnnouncement

public static DataQualityRule updateAnnouncement(AtlanClient client,
 String qualifiedName,
 AtlanAnnouncementType type,
 String title,
 String message)
                                          throws AtlanException

Update the announcement on a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant on which to update the DataQualityRule's announcement

qualifiedName - of the DataQualityRule

type - type of announcement to set

title - (optional) title of the announcement to set (or null for no title)

message - (optional) message of the announcement to set (or null for no message)

Returns:

the result of the update, or null if the update failed

Throws:

AtlanException - on any API problems

removeAnnouncement

public static DataQualityRule removeAnnouncement(AtlanClient client,
 String qualifiedName,
 String name)
                                          throws AtlanException

Remove the announcement from a DataQualityRule.

Parameters:

client - connectivity to the Atlan client from which to remove the DataQualityRule's announcement

qualifiedName - of the DataQualityRule

name - of the DataQualityRule

Returns:

the updated DataQualityRule, or null if the removal failed

Throws:

AtlanException - on any API problems

replaceTerms

public static DataQualityRule replaceTerms(AtlanClient client,
 String qualifiedName,
 String name,
 List<IGlossaryTerm> terms)
                                    throws AtlanException

Replace the terms linked to the DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant on which to replace the DataQualityRule's assigned terms

qualifiedName - for the DataQualityRule

name - human-readable name of the DataQualityRule

terms - the list of terms to replace on the DataQualityRule, or null to remove all terms from the DataQualityRule

Returns:

the DataQualityRule that was updated (note that it will NOT contain details of the replaced terms)

Throws:

AtlanException - on any API problems

appendTerms

@Deprecated
public static DataQualityRule appendTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                                   throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

Link additional terms to the DataQualityRule, without replacing existing terms linked to the DataQualityRule. Note: this operation must make two API calls — one to retrieve the DataQualityRule's existing terms, and a second to append the new terms.

Parameters:

client - connectivity to the Atlan tenant on which to append terms to the DataQualityRule

qualifiedName - for the DataQualityRule

terms - the list of terms to append to the DataQualityRule

Returns:

the DataQualityRule that was updated (note that it will NOT contain details of the appended terms)

Throws:

AtlanException - on any API problems

removeTerms

@Deprecated
public static DataQualityRule removeTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                                   throws AtlanException

Deprecated.

see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

Remove terms from a DataQualityRule, without replacing all existing terms linked to the DataQualityRule. Note: this operation must make two API calls — one to retrieve the DataQualityRule's existing terms, and a second to remove the provided terms.

Parameters:

client - connectivity to the Atlan tenant from which to remove terms from the DataQualityRule

qualifiedName - for the DataQualityRule

terms - the list of terms to remove from the DataQualityRule, which must be referenced by GUID

Returns:

the DataQualityRule that was updated (note that it will NOT contain details of the resulting terms)

Throws:

AtlanException - on any API problems

appendAtlanTags

@Deprecated
public static DataQualityRule appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames)
                                       throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List)

Add Atlan tags to a DataQualityRule, without replacing existing Atlan tags linked to the DataQualityRule. Note: this operation must make two API calls — one to retrieve the DataQualityRule's existing Atlan tags, and a second to append the new Atlan tags.

Parameters:

client - connectivity to the Atlan tenant on which to append Atlan tags to the DataQualityRule

qualifiedName - of the DataQualityRule

atlanTagNames - human-readable names of the Atlan tags to add

Returns:

the updated DataQualityRule

Throws:

AtlanException - on any API problems

appendAtlanTags

@Deprecated
public static DataQualityRule appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames,
 boolean propagate,
 boolean removePropagationsOnDelete,
 boolean restrictLineagePropagation)
                                       throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)

Add Atlan tags to a DataQualityRule, without replacing existing Atlan tags linked to the DataQualityRule. Note: this operation must make two API calls — one to retrieve the DataQualityRule's existing Atlan tags, and a second to append the new Atlan tags.

Parameters:

client - connectivity to the Atlan tenant on which to append Atlan tags to the DataQualityRule

qualifiedName - of the DataQualityRule

atlanTagNames - human-readable names of the Atlan tags to add

propagate - whether to propagate the Atlan tag (true) or not (false)

removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)

restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)

Returns:

the updated DataQualityRule

Throws:

AtlanException - on any API problems

removeAtlanTag

@Deprecated
public static void removeAtlanTag(AtlanClient client,
 String qualifiedName,
 String atlanTagName)
                           throws AtlanException

Deprecated.

see Asset.AssetBuilder.removeAtlanTag(String)

Remove an Atlan tag from a DataQualityRule.

Parameters:

client - connectivity to the Atlan tenant from which to remove an Atlan tag from a DataQualityRule

qualifiedName - of the DataQualityRule

atlanTagName - human-readable name of the Atlan tag to remove

Throws:

AtlanException - on any API problems, or if the Atlan tag does not exist on the DataQualityRule

_internal

public static DataQualityRule.DataQualityRuleBuilder<?,?> _internal()

toBuilder

public DataQualityRule.DataQualityRuleBuilder<?,?> toBuilder()

Overrides:

toBuilder in class Reference

getCatalogDatasetGuid

public String getCatalogDatasetGuid()

Unique identifier of the dataset this asset belongs to.

Specified by:

getCatalogDatasetGuid in interface ICatalog

Specified by:

getCatalogDatasetGuid in interface IDataQuality

Specified by:

getCatalogDatasetGuid in interface IDataQualityRule

getDqIsPartOfContract

public Boolean getDqIsPartOfContract()

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

Specified by:

getDqIsPartOfContract in interface IDataQuality

Specified by:

getDqIsPartOfContract in interface IDataQualityRule

getDqRuleADStatus

public DataQualityRuleADStatus getDqRuleADStatus()

Anomaly detection lifecycle status for this rule.

Specified by:

getDqRuleADStatus in interface IDataQualityRule

getDqRuleAlertPriority

public DataQualityRuleAlertPriority getDqRuleAlertPriority()

Default priority level for alerts involving this rule.

Specified by:

getDqRuleAlertPriority in interface IDataQualityRule

getDqRuleBaseColumn

public IColumn getDqRuleBaseColumn()

Base column attached to this rule.

Specified by:

getDqRuleBaseColumn in interface IDataQualityRule

getDqRuleBaseColumnQualifiedName

public String getDqRuleBaseColumnQualifiedName()

Base column qualified name that attached to this rule.

Specified by:

getDqRuleBaseColumnQualifiedName in interface IDataQualityRule

getDqRuleBaseDataset

public IAsset getDqRuleBaseDataset()

Base dataset attached to this rule.

Specified by:

getDqRuleBaseDataset in interface IDataQualityRule

getDqRuleBaseDatasetQualifiedName

public String getDqRuleBaseDatasetQualifiedName()

Base dataset qualified name that attached to this rule.

Specified by:

getDqRuleBaseDatasetQualifiedName in interface IDataQualityRule

getDqRuleConfigArguments

public DataQualityRuleConfigArguments getDqRuleConfigArguments()

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

Specified by:

getDqRuleConfigArguments in interface IDataQualityRule

getDqRuleCustomSQL

public String getDqRuleCustomSQL()

SQL code for custom SQL rules.

Specified by:

getDqRuleCustomSQL in interface IDataQualityRule

getDqRuleCustomSQLReturnType

public DataQualityRuleCustomSQLReturnType getDqRuleCustomSQLReturnType()

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

Specified by:

getDqRuleCustomSQLReturnType in interface IDataQualityRule

getDqRuleDimension

public DataQualityDimension getDqRuleDimension()

Dimension of the data quality rule.

Specified by:

getDqRuleDimension in interface IDataQualityRule

getDqRuleFailedRowsSQL

public String getDqRuleFailedRowsSQL()

SQL query used to retrieve failed rows.

Specified by:

getDqRuleFailedRowsSQL in interface IDataQualityRule

getDqRuleLatestMetricValue

public String getDqRuleLatestMetricValue()

Last result metrics value of the rule.

Specified by:

getDqRuleLatestMetricValue in interface IDataQualityRule

getDqRuleLatestMetricValueComputedAt

public Long getDqRuleLatestMetricValueComputedAt()

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

Specified by:

getDqRuleLatestMetricValueComputedAt in interface IDataQualityRule

getDqRuleLatestResult

public DataQualityResult getDqRuleLatestResult()

Latest result of the rule.

Specified by:

getDqRuleLatestResult in interface IDataQualityRule

getDqRuleLatestResultComputedAt

public Long getDqRuleLatestResultComputedAt()

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

Specified by:

getDqRuleLatestResultComputedAt in interface IDataQualityRule

getDqRuleLatestResultDetails

public String getDqRuleLatestResultDetails()

JSON string with anomaly detection result details (forecast, upper_bound, lower_bound, is_anomaly) from Snowflake AD.

Specified by:

getDqRuleLatestResultDetails in interface IDataQualityRule

getDqRuleLatestResultFetchedAt

public Long getDqRuleLatestResultFetchedAt()

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

Specified by:

getDqRuleLatestResultFetchedAt in interface IDataQualityRule

getDqRuleReferenceColumnQualifiedNames

public SortedSet<String> getDqRuleReferenceColumnQualifiedNames()

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

Specified by:

getDqRuleReferenceColumnQualifiedNames in interface IDataQualityRule

getDqRuleReferenceColumns

public SortedSet<IColumn> getDqRuleReferenceColumns()

Columns referenced in this rule.

Specified by:

getDqRuleReferenceColumns in interface IDataQualityRule

getDqRuleReferenceDatasetQualifiedNames

public SortedSet<String> getDqRuleReferenceDatasetQualifiedNames()

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

Specified by:

getDqRuleReferenceDatasetQualifiedNames in interface IDataQualityRule

getDqRuleReferenceDatasets

public SortedSet<IAsset> getDqRuleReferenceDatasets()

Datasets referenced in this rule.

Specified by:

getDqRuleReferenceDatasets in interface IDataQualityRule

getDqRuleRowScopeFilteringEnabled

public Boolean getDqRuleRowScopeFilteringEnabled()

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

Specified by:

getDqRuleRowScopeFilteringEnabled in interface IDataQualityRule

getDqRuleSourceSyncErrorCode

public String getDqRuleSourceSyncErrorCode()

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

Specified by:

getDqRuleSourceSyncErrorCode in interface IDataQualityRule

getDqRuleSourceSyncErrorMessage

public String getDqRuleSourceSyncErrorMessage()

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

Specified by:

getDqRuleSourceSyncErrorMessage in interface IDataQualityRule

getDqRuleSourceSyncRawError

public String getDqRuleSourceSyncRawError()

Raw error message from the source.

Specified by:

getDqRuleSourceSyncRawError in interface IDataQualityRule

getDqRuleSourceSyncStatus

public DataQualitySourceSyncStatus getDqRuleSourceSyncStatus()

Latest sync status of the rule to the source.

Specified by:

getDqRuleSourceSyncStatus in interface IDataQualityRule

getDqRuleSourceSyncedAt

public Long getDqRuleSourceSyncedAt()

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

Specified by:

getDqRuleSourceSyncedAt in interface IDataQualityRule

getDqRuleStatus

public DataQualityRuleStatus getDqRuleStatus()

Status of the rule.

Specified by:

getDqRuleStatus in interface IDataQualityRule

getDqRuleTemplate

public IDataQualityRuleTemplate getDqRuleTemplate()

Template used to create this rule.

Specified by:

getDqRuleTemplate in interface IDataQualityRule

getDqRuleTemplateName

public String getDqRuleTemplateName()

Name of the rule template corresponding to the rule.

Specified by:

getDqRuleTemplateName in interface IDataQualityRule

getInputToAirflowTasks

public SortedSet<IAirflowTask> getInputToAirflowTasks()

Tasks to which this asset provides input.

Specified by:

getInputToAirflowTasks in interface ICatalog

Specified by:

getInputToAirflowTasks in interface IDataQuality

Specified by:

getInputToAirflowTasks in interface IDataQualityRule

getInputToProcesses

public SortedSet<ILineageProcess> getInputToProcesses()

Processes to which this asset provides input.

Specified by:

getInputToProcesses in interface ICatalog

Specified by:

getInputToProcesses in interface IDataQuality

Specified by:

getInputToProcesses in interface IDataQualityRule

getInputToSparkJobs

public SortedSet<ISparkJob> getInputToSparkJobs()

TBC

Specified by:

getInputToSparkJobs in interface ICatalog

Specified by:

getInputToSparkJobs in interface IDataQuality

Specified by:

getInputToSparkJobs in interface IDataQualityRule

getModelImplementedAttributes

public SortedSet<IModelAttribute> getModelImplementedAttributes()

Attributes implemented by this asset.

Specified by:

getModelImplementedAttributes in interface ICatalog

Specified by:

getModelImplementedAttributes in interface IDataQuality

Specified by:

getModelImplementedAttributes in interface IDataQualityRule

getModelImplementedEntities

public SortedSet<IModelEntity> getModelImplementedEntities()

Entities implemented by this asset.

Specified by:

getModelImplementedEntities in interface ICatalog

Specified by:

getModelImplementedEntities in interface IDataQuality

Specified by:

getModelImplementedEntities in interface IDataQualityRule

getOutputFromAirflowTasks

public SortedSet<IAirflowTask> getOutputFromAirflowTasks()

Tasks from which this asset is output.

Specified by:

getOutputFromAirflowTasks in interface ICatalog

Specified by:

getOutputFromAirflowTasks in interface IDataQuality

Specified by:

getOutputFromAirflowTasks in interface IDataQualityRule

getOutputFromProcesses

public SortedSet<ILineageProcess> getOutputFromProcesses()

Processes from which this asset is produced as output.

Specified by:

getOutputFromProcesses in interface ICatalog

Specified by:

getOutputFromProcesses in interface IDataQuality

Specified by:

getOutputFromProcesses in interface IDataQualityRule

getOutputFromSparkJobs

public SortedSet<ISparkJob> getOutputFromSparkJobs()

TBC

Specified by:

getOutputFromSparkJobs in interface ICatalog

Specified by:

getOutputFromSparkJobs in interface IDataQuality

Specified by:

getOutputFromSparkJobs in interface IDataQualityRule

getPartialChildFields

public SortedSet<IPartialField> getPartialChildFields()

Partial fields contained in the asset.

Specified by:

getPartialChildFields in interface ICatalog

Specified by:

getPartialChildFields in interface IDataQuality

Specified by:

getPartialChildFields in interface IDataQualityRule

getPartialChildObjects

public SortedSet<IPartialObject> getPartialChildObjects()

Partial objects contained in the asset.

Specified by:

getPartialChildObjects in interface ICatalog

Specified by:

getPartialChildObjects in interface IDataQuality

Specified by:

getPartialChildObjects in interface IDataQualityRule

equals

public boolean equals(Object o)

Overrides:

equals in class Asset

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class Asset

hashCode

public int hashCode()

Overrides:

hashCode in class Asset

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class Asset

getTypeName

public String getTypeName()

Fixed typeName for DataQualityRules.

Specified by:

getTypeName in interface AuditDetail

Specified by:

getTypeName in interface IAsset

Specified by:

getTypeName in interface ICatalog

Specified by:

getTypeName in interface IDataQuality

Specified by:

getTypeName in interface IDataQualityRule

Specified by:

getTypeName in interface IReferenceable

Overrides:

getTypeName in class Reference