Package com.atlan.model.assets
Class DataDomain
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.DataDomain
- All Implemented Interfaces:
IAsset
,ICatalog
,IDataDomain
,IDataMesh
,IReferenceable
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class DataDomain
extends Asset
implements IDataDomain, IDataMesh, ICatalog, IAsset, IReferenceable
Instance of a data domain in Atlan.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
DataDomain.DataDomainBuilder<C extends DataDomain,
B extends DataDomain.DataDomainBuilder<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 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, 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_ICON, 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_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_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_TAGS, ASSET_THEME_HEX, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, 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, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, 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
APPLICATION_CONTAINER, ASSET_APPLICATION_QUALIFIED_NAME, INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS
Fields inherited from interface com.atlan.model.assets.IDataDomain
DATA_PRODUCTS, PARENT_DOMAIN, STAKEHOLDERS, SUB_DOMAINS
Fields inherited from interface com.atlan.model.assets.IDataMesh
PARENT_DOMAIN_QUALIFIED_NAME, SUPER_DOMAIN_QUALIFIED_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
-
Method Summary
Modifier and TypeMethodDescriptionstatic DataDomain.DataDomainBuilder<?,
?> static DataDomain
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain.static DataDomain
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain.static DataDomain
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain.static DataDomain
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain.static DataDomain
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the DataDomain, without replacing existing terms linked to the DataDomain.static DataDomain
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the DataDomain, without replacing existing terms linked to the DataDomain.protected boolean
static DataDomain.DataDomainBuilder<?,
?> Builds the minimal object necessary for creating a DataDomain.static DataDomain.DataDomainBuilder<?,
?> Builds the minimal object necessary for creating a DataDomain.boolean
static List<DataDomain>
findByName
(AtlanClient client, String name) Find a DataDomain by its human-readable name.static List<DataDomain>
findByName
(AtlanClient client, String name, Collection<String> attributes) Find a DataDomain by its human-readable name.static List<DataDomain>
findByName
(AtlanClient client, String name, List<AtlanField> attributes) Find a DataDomain by its human-readable name.static List<DataDomain>
findByName
(String name) Find a DataDomain by its human-readable name.static List<DataDomain>
findByName
(String name, Collection<String> attributes) Find a DataDomain by its human-readable name.static List<DataDomain>
findByName
(String name, List<AtlanField> attributes) Find a DataDomain by its human-readable name.static DataDomain
get
(AtlanClient client, String id) Retrieves a DataDomain by one of its identifiers, complete with all of its relationships.static DataDomain
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a DataDomain by one of its identifiers, optionally complete with all of its relationships.static DataDomain
Retrieves a DataDomain by one of its identifiers, complete with all of its relationships.ApplicationContainer asset containing this Catalog asset.Qualified name of the Application Container that contains this asset.Data products that exist within this data domain.Tasks to which this asset provides input.Processes to which this asset provides input.TBCEntities implemented by this asset.Tasks from which this asset is output.Processes from which this asset is produced as output.TBCParent data domain in which this sub-data domain exists.Unique name of the parent domain in which this asset exists.Stakeholder assigned to the DomainSub-data domains that exist within this data domain.Unique name of the top-level domain in which this asset exists.Fixed typeName for DataDomains.int
hashCode()
static DataDomain
Reference to a DataDomain by GUID.static DataDomain
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a DataDomain by GUID.static DataDomain
refByQualifiedName
(String qualifiedName) Reference to a DataDomain by qualifiedName.static DataDomain
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a DataDomain by qualifiedName.static DataDomain
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a DataDomain.static DataDomain
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a DataDomain.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a DataDomain.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a DataDomain.static DataDomain
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a DataDomain.static DataDomain
removeCertificate
(String qualifiedName, String name) Remove the certificate from a DataDomain.static DataDomain
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a DataDomain.static DataDomain
removeDescription
(String qualifiedName, String name) Remove the system description from a DataDomain.static DataDomain
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a DataDomain.static DataDomain
removeOwners
(String qualifiedName, String name) Remove the owners from a DataDomain.static DataDomain
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a DataDomain, without replacing all existing terms linked to the DataDomain.static DataDomain
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a DataDomain, without replacing all existing terms linked to the DataDomain.static DataDomain
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a DataDomain.static DataDomain
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a DataDomain.static DataDomain
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the DataDomain.static DataDomain
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the DataDomain.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) DataDomain to active.static boolean
Restore the archived (soft-deleted) DataDomain to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all DataDomain assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all DataDomain assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all DataDomain assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all DataDomain assets.toString()
Builds the minimal object necessary to create a relationship to a DataDomain, from a potentially more-complete DataDomain object.Builds the minimal object necessary to apply an update to a DataDomain, from a potentially more-complete DataDomain object.static DataDomain
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a DataDomain.static DataDomain
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a DataDomain.static DataDomain
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a DataDomain.static DataDomain
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a DataDomain.static DataDomain.DataDomainBuilder<?,
?> Builds the minimal object necessary to update a DataDomain.Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getCreatedBy, getCreateTime, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getFiles, getHasContract, getHasLineage, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, 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, lineage, lineage, purge, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceCustomMetadata, replaceTerms, requestLineage, requestLineage, restore, save, save, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM
Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, 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, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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.IDataDomain
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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.IDataMesh
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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
- See Also:
-
-
Constructor Details
-
DataDomain
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a DataDomain, from a potentially more-complete DataDomain object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the DataDomain
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a DataDomain relationship are not found in the initial object
-
select
Start a fluent search that will return all DataDomain 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) DataDomain assets will be included.- Returns:
- a fluent search that includes all DataDomain assets
-
select
Start a fluent search that will return all DataDomain 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) DataDomain assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all DataDomain assets
-
select
Start a fluent search that will return all DataDomain 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:
includeArchived
- when true, archived (soft-deleted) DataDomains will be included- Returns:
- a fluent search that includes all DataDomain assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all DataDomain 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 assetsincludeArchived
- when true, archived (soft-deleted) DataDomains will be included- Returns:
- a fluent search that includes all DataDomain assets
-
refByGuid
Reference to a DataDomain by GUID. Use this to create a relationship to this DataDomain, where the relationship should be replaced.- Parameters:
guid
- the GUID of the DataDomain to reference- Returns:
- reference to a DataDomain that can be used for defining a relationship to a DataDomain
-
refByGuid
Reference to a DataDomain by GUID. Use this to create a relationship to this DataDomain, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the DataDomain to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a DataDomain that can be used for defining a relationship to a DataDomain
-
refByQualifiedName
Reference to a DataDomain by qualifiedName. Use this to create a relationship to this DataDomain, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the DataDomain to reference- Returns:
- reference to a DataDomain that can be used for defining a relationship to a DataDomain
-
refByQualifiedName
Reference to a DataDomain by qualifiedName. Use this to create a relationship to this DataDomain, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the DataDomain to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a DataDomain that can be used for defining a relationship to a DataDomain
-
get
Retrieves a DataDomain by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the DataDomain to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full DataDomain, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the DataDomain does not exist or the provided GUID is not a DataDomain
-
get
Retrieves a DataDomain by one of its identifiers, complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the DataDomain to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full DataDomain, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the DataDomain does not exist or the provided GUID is not a DataDomain
-
get
public static DataDomain get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a DataDomain by one of its identifiers, optionally complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the DataDomain to retrieve, either its GUID or its full qualifiedNameincludeRelationships
- if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full DataDomain, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the DataDomain does not exist or the provided GUID is not a DataDomain
-
restore
Restore the archived (soft-deleted) DataDomain to active.- Parameters:
qualifiedName
- for the DataDomain- Returns:
- true if the DataDomain is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) DataDomain to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the DataDomain- Returns:
- true if the DataDomain is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
creator
Builds the minimal object necessary for creating a DataDomain.- Parameters:
name
- of the DataDomain- Returns:
- the minimal request necessary to create the DataDomain, as a builder
- Throws:
InvalidRequestException
- will never throw but required given signature of called method
-
creator
public static DataDomain.DataDomainBuilder<?,?> creator(String name, String parentDomainQualifiedName) throws InvalidRequestException Builds the minimal object necessary for creating a DataDomain.- Parameters:
name
- of the DataDomainparentDomainQualifiedName
- (optional) unique name of the data domain in which to create this subdomain- Returns:
- the minimal request necessary to create the DataDomain, as a builder
- Throws:
InvalidRequestException
-
updater
Builds the minimal object necessary to update a DataDomain.- Parameters:
qualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the minimal request necessary to update the DataDomain, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a DataDomain, from a potentially more-complete DataDomain object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the DataDomain, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for DataDomain are not found in the initial object
-
findByName
Find a DataDomain by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the domain, if found. Note that domains are not unique by name, so there may be multiple results.- Parameters:
name
- of the DataDomain- Returns:
- the DataDomain, if found
- Throws:
AtlanException
- on any API problems, or if the DataDomain does not exist
-
findByName
public static List<DataDomain> findByName(String name, Collection<String> attributes) throws AtlanException Find a DataDomain by its human-readable name. Note that domains are not unique by name, so there may be multiple results.- Parameters:
name
- of the DataDomainattributes
- an optional collection of attributes (unchecked) to retrieve for the DataDomain- Returns:
- the DataDomain, if found
- Throws:
AtlanException
- on any API problems, or if the DataDomain does not exist
-
findByName
public static List<DataDomain> findByName(String name, List<AtlanField> attributes) throws AtlanException Find a DataDomain by its human-readable name. Note that domains are not unique by name, so there may be multiple results.- Parameters:
name
- of the DataDomainattributes
- an optional collection of attributes (checked) to retrieve for the DataDomain- Returns:
- the DataDomain, if found
- Throws:
AtlanException
- on any API problems, or if the DataDomain does not exist
-
findByName
Find a DataDomain by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the domain, if found.- Parameters:
client
- connectivity to the Atlan tenant on which to search for the DataDomainname
- of the DataDomain- Returns:
- the DataDomain, if found
- Throws:
AtlanException
- on any API problems, or if the DataDomain does not exist
-
findByName
public static List<DataDomain> findByName(AtlanClient client, String name, Collection<String> attributes) throws AtlanException Find a DataDomain by its human-readable name. Note that domains are not unique by name, so there may be multiple results.- Parameters:
client
- connectivity to the Atlan tenant on which to search for the DataDomainname
- of the DataDomainattributes
- an optional collection of attributes (unchecked) to retrieve for the DataDomain- Returns:
- the DataDomain, if found
- Throws:
AtlanException
- on any API problems, or if the DataDomain does not exist
-
findByName
public static List<DataDomain> findByName(AtlanClient client, String name, List<AtlanField> attributes) throws AtlanException Find a DataDomain by its human-readable name. Note that domains are not unique by name, so there may be multiple results.- Parameters:
client
- connectivity to the Atlan tenant on which to search for the DataDomainname
- of the DataDomainattributes
- an optional collection of attributes (checked) to retrieve for the DataDomain- Returns:
- the DataDomain, if found
- Throws:
AtlanException
- on any API problems, or if the DataDomain does not exist
-
removeDescription
Remove the system description from a DataDomain.- Parameters:
qualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static DataDomain removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static DataDomain removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a DataDomain.- Parameters:
qualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static DataDomain removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a DataDomain.- Parameters:
qualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static DataDomain removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the DataDomain's ownersqualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static DataDomain updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a DataDomain.- Parameters:
qualifiedName
- of the DataDomaincertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated DataDomain, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static DataDomain updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant on which to update the DataDomain's certificatequalifiedName
- of the DataDomaincertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated DataDomain, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
Remove the certificate from a DataDomain.- Parameters:
qualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static DataDomain removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the DataDomain's certificatequalifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static DataDomain updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a DataDomain.- Parameters:
qualifiedName
- of the DataDomaintype
- type of announcement to settitle
- (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
-
updateAnnouncement
public static DataDomain updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant on which to update the DataDomain's announcementqualifiedName
- of the DataDomaintype
- type of announcement to settitle
- (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 DataDomain removeAnnouncement(String qualifiedName, String name) throws AtlanException Remove the announcement from a DataDomain.- Parameters:
qualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static DataDomain removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a DataDomain.- Parameters:
client
- connectivity to the Atlan client from which to remove the DataDomain's announcementqualifiedName
- of the DataDomainname
- of the DataDomain- Returns:
- the updated DataDomain, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static DataDomain replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the DataDomain.- Parameters:
qualifiedName
- for the DataDomainname
- human-readable name of the DataDomainterms
- the list of terms to replace on the DataDomain, or null to remove all terms from the DataDomain- Returns:
- the DataDomain that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static DataDomain replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the DataDomain.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the DataDomain's assigned termsqualifiedName
- for the DataDomainname
- human-readable name of the DataDomainterms
- the list of terms to replace on the DataDomain, or null to remove all terms from the DataDomain- Returns:
- the DataDomain that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static DataDomain appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the DataDomain, without replacing existing terms linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the DataDomainterms
- the list of terms to append to the DataDomain- Returns:
- the DataDomain that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static DataDomain appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the DataDomain, without replacing existing terms linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain'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 DataDomainqualifiedName
- for the DataDomainterms
- the list of terms to append to the DataDomain- Returns:
- the DataDomain that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static DataDomain removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a DataDomain, without replacing all existing terms linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the DataDomainterms
- the list of terms to remove from the DataDomain, which must be referenced by GUID- Returns:
- the DataDomain that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static DataDomain removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a DataDomain, without replacing all existing terms linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain'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 DataDomainqualifiedName
- for the DataDomainterms
- the list of terms to remove from the DataDomain, which must be referenced by GUID- Returns:
- the DataDomain that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataDomain appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the DataDomainatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated DataDomain
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataDomain appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain'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 DataDomainqualifiedName
- of the DataDomainatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated DataDomain
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataDomain appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the DataDomainatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- 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 DataDomain
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataDomain appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a DataDomain, without replacing existing Atlan tags linked to the DataDomain. Note: this operation must make two API calls — one to retrieve the DataDomain'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 DataDomainqualifiedName
- of the DataDomainatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- 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 DataDomain
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a DataDomain.- Parameters:
qualifiedName
- of the DataDomainatlanTagName
- 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 DataDomain
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a DataDomain.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a DataDomainqualifiedName
- of the DataDomainatlanTagName
- 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 DataDomain
-
_internal
-
toBuilder
-
getApplicationContainer
ApplicationContainer asset containing this Catalog asset.- Specified by:
getApplicationContainer
in interfaceICatalog
- Specified by:
getApplicationContainer
in interfaceIDataDomain
- Specified by:
getApplicationContainer
in interfaceIDataMesh
-
getAssetApplicationQualifiedName
Qualified name of the Application Container that contains this asset.- Specified by:
getAssetApplicationQualifiedName
in interfaceICatalog
- Specified by:
getAssetApplicationQualifiedName
in interfaceIDataDomain
- Specified by:
getAssetApplicationQualifiedName
in interfaceIDataMesh
-
getDataProducts
Data products that exist within this data domain.- Specified by:
getDataProducts
in interfaceIDataDomain
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasks
in interfaceICatalog
- Specified by:
getInputToAirflowTasks
in interfaceIDataDomain
- Specified by:
getInputToAirflowTasks
in interfaceIDataMesh
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcesses
in interfaceICatalog
- Specified by:
getInputToProcesses
in interfaceIDataDomain
- Specified by:
getInputToProcesses
in interfaceIDataMesh
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobs
in interfaceICatalog
- Specified by:
getInputToSparkJobs
in interfaceIDataDomain
- Specified by:
getInputToSparkJobs
in interfaceIDataMesh
-
getModelImplementedEntities
Entities implemented by this asset.- Specified by:
getModelImplementedEntities
in interfaceICatalog
- Specified by:
getModelImplementedEntities
in interfaceIDataDomain
- Specified by:
getModelImplementedEntities
in interfaceIDataMesh
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasks
in interfaceICatalog
- Specified by:
getOutputFromAirflowTasks
in interfaceIDataDomain
- Specified by:
getOutputFromAirflowTasks
in interfaceIDataMesh
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcesses
in interfaceICatalog
- Specified by:
getOutputFromProcesses
in interfaceIDataDomain
- Specified by:
getOutputFromProcesses
in interfaceIDataMesh
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobs
in interfaceICatalog
- Specified by:
getOutputFromSparkJobs
in interfaceIDataDomain
- Specified by:
getOutputFromSparkJobs
in interfaceIDataMesh
-
getParentDomain
Parent data domain in which this sub-data domain exists.- Specified by:
getParentDomain
in interfaceIDataDomain
-
getParentDomainQualifiedName
Unique name of the parent domain in which this asset exists.- Specified by:
getParentDomainQualifiedName
in interfaceIDataDomain
- Specified by:
getParentDomainQualifiedName
in interfaceIDataMesh
-
getStakeholders
Stakeholder assigned to the Domain- Specified by:
getStakeholders
in interfaceIDataDomain
-
getSubDomains
Sub-data domains that exist within this data domain.- Specified by:
getSubDomains
in interfaceIDataDomain
-
getSuperDomainQualifiedName
Unique name of the top-level domain in which this asset exists.- Specified by:
getSuperDomainQualifiedName
in interfaceIDataDomain
- Specified by:
getSuperDomainQualifiedName
in interfaceIDataMesh
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for DataDomains.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceICatalog
- Specified by:
getTypeName
in interfaceIDataDomain
- Specified by:
getTypeName
in interfaceIDataMesh
- Specified by:
getTypeName
in interfaceIReferenceable
- Overrides:
getTypeName
in classReference
-