Package com.atlan.model.assets
Class DMEntity
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.DMEntity
- All Implemented Interfaces:
IAsset,ICatalog,IDM,IDMEntity,IReferenceable,AuditDetail,Serializable,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class DMEntity
extends Asset
implements IDMEntity, IDM, ICatalog, IAsset, IReferenceable
Instance of an entity within a version of a data model in Atlan.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classDMEntity.DMEntityBuilder<C extends DMEntity,B extends DMEntity.DMEntityBuilder<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
FieldsFields inherited from class com.atlan.model.core.AtlanObject
rawJsonObjectFields 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_GUI_DS, 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_GUI_DS, 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_GUI_DS, 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_USERSFields inherited from interface com.atlan.model.assets.ICatalog
INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBSFields inherited from interface com.atlan.model.assets.IDM
DM_BUSINESS_DATE, DM_DATA_MODEL_DOMAIN, DM_DATA_MODEL_NAME, DM_DATA_MODEL_NAMESPACE, DM_DATA_MODEL_QUALIFIED_NAME, DM_ENTITY_NAME, DM_ENTITY_QUALIFIED_NAME, DM_EXPIRED_AT_BUSINESS_DATE, DM_EXPIRED_AT_SYSTEM_DATE, DM_SYSTEM_DATE, DM_VERSION_NAME, DM_VERSION_QUALIFIED_NAMEFields inherited from interface com.atlan.model.assets.IDMEntity
DM_ATTRIBUTE_COUNT, DM_ATTRIBUTES, DM_ENTITY_TYPE, DM_MAPPED_FROM_ENTITIES, DM_MAPPED_TO_ENTITIES, DM_RELATED_FROM_ENTITIES, DM_RELATED_TO_ENTITIES, DM_SUBJECT_AREA, DM_VERSIONSFields 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 -
Method Summary
Modifier and TypeMethodDescriptionstatic DMEntity.DMEntityBuilder<?,?> static DMEntityappendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity.static DMEntityappendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity.static DMEntityappendAtlanTags(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity.static DMEntityappendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity.static DMEntityappendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the DMEntity, without replacing existing terms linked to the DMEntity.static DMEntityappendTerms(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the DMEntity, without replacing existing terms linked to the DMEntity.protected booleanbooleanstatic DMEntityget(AtlanClient client, String id) Retrieves a DMEntity by one of its identifiers, complete with all of its relationships.static DMEntityget(AtlanClient client, String id, boolean includeRelationships) Retrieves a DMEntity by one of its identifiers, optionally complete with all of its relationships.static DMEntityRetrieves a DMEntity by one of its identifiers, complete with all of its relationships.Number of attributes in the entity.Individual attributes that make up the entity.Business date for the asset.A domain of the data model in which this asset exists.Simple name of the model in which this asset exists, or empty if it is itself a data model.A namespace of the data model in which this asset exists.Unique name of the model in which this asset exists, or empty if it is itself a data model.Simple name of the entity in which this asset exists, or empty if it is itself a data model entity.Unique name of the entity in which this asset exists, or empty if it is itself a data model entity.Type of the data entity.Business expiration date for the asset.System expiration date for the asset.Entities from which this entity is mapped.Entities to which this entity is mapped.Association from this entity is related.Association to which this entity is related.Subject area of the entity.System date for the asset.Simple name of the version in which this asset exists, or empty if it is itself a data model version.Unique name of the version in which this asset exists, or empty if it is itself a data model version.Data model version(s) in which this entity exists.Tasks to which this asset provides input.Processes to which this asset provides input.TBCTasks from which this asset is output.Processes from which this asset is produced as output.TBCFixed typeName for DMEntitys.inthashCode()static DMEntityReference to a DMEntity by GUID.static DMEntityrefByGuid(String guid, Reference.SaveSemantic semantic) Reference to a DMEntity by GUID.static DMEntityrefByQualifiedName(String qualifiedName) Reference to a DMEntity by qualifiedName.static DMEntityrefByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a DMEntity by qualifiedName.static DMEntityremoveAnnouncement(AtlanClient client, String qualifiedName, String name) Remove the announcement from a DMEntity.static DMEntityremoveAnnouncement(String qualifiedName, String name) Remove the announcement from a DMEntity.static voidremoveAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a DMEntity.static voidremoveAtlanTag(String qualifiedName, String atlanTagName) Remove an Atlan tag from a DMEntity.static DMEntityremoveCertificate(AtlanClient client, String qualifiedName, String name) Remove the certificate from a DMEntity.static DMEntityremoveCertificate(String qualifiedName, String name) Remove the certificate from a DMEntity.static DMEntityremoveDescription(AtlanClient client, String qualifiedName, String name) Remove the system description from a DMEntity.static DMEntityremoveDescription(String qualifiedName, String name) Remove the system description from a DMEntity.static DMEntityremoveOwners(AtlanClient client, String qualifiedName, String name) Remove the owners from a DMEntity.static DMEntityremoveOwners(String qualifiedName, String name) Remove the owners from a DMEntity.static DMEntityremoveTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a DMEntity, without replacing all existing terms linked to the DMEntity.static DMEntityremoveTerms(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a DMEntity, without replacing all existing terms linked to the DMEntity.static DMEntityremoveUserDescription(AtlanClient client, String qualifiedName, String name) Remove the user's description from a DMEntity.static DMEntityremoveUserDescription(String qualifiedName, String name) Remove the user's description from a DMEntity.static DMEntityreplaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the DMEntity.static DMEntityreplaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the DMEntity.static booleanrestore(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) DMEntity to active.static booleanRestore the archived (soft-deleted) DMEntity to active.static FluentSearch.FluentSearchBuilder<?,?> select()Start a fluent search that will return all DMEntity assets.static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived) Start a fluent search that will return all DMEntity assets.static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client) Start a fluent search that will return all DMEntity assets.static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all DMEntity assets.toString()Builds the minimal object necessary to create a relationship to a DMEntity, from a potentially more-complete DMEntity object.Builds the minimal object necessary to apply an update to a DMEntity, from a potentially more-complete DMEntity object.static DMEntityupdateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a DMEntity.static DMEntityupdateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a DMEntity.static DMEntityupdateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a DMEntity.static DMEntityupdateCertificate(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a DMEntity.static DMEntity.DMEntityBuilder<?,?> Builds the minimal object necessary to update a DMEntity.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, updateReplacingCMMethods 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, validateRequiredMethods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJsonMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObjectMethods 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, isValidReferenceByQualifiedNameMethods 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, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IDM
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, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IDMEntity
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, isValidReferenceByQualifiedNameMethods 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
-
DMEntity
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a DMEntity, from a potentially more-complete DMEntity object.- Overrides:
trimToReferencein classAsset- Returns:
- the minimal object necessary to relate to the DMEntity
- Throws:
InvalidRequestException- if any of the minimal set of required properties for a DMEntity relationship are not found in the initial object
-
select
Start a fluent search that will return all DMEntity 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) DMEntity assets will be included.- Returns:
- a fluent search that includes all DMEntity assets
-
select
Start a fluent search that will return all DMEntity 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) DMEntity assets will be included.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all DMEntity assets
-
select
Start a fluent search that will return all DMEntity 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) DMEntitys will be included- Returns:
- a fluent search that includes all DMEntity assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all DMEntity 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) DMEntitys will be included- Returns:
- a fluent search that includes all DMEntity assets
-
refByGuid
Reference to a DMEntity by GUID. Use this to create a relationship to this DMEntity, where the relationship should be replaced.- Parameters:
guid- the GUID of the DMEntity to reference- Returns:
- reference to a DMEntity that can be used for defining a relationship to a DMEntity
-
refByGuid
Reference to a DMEntity by GUID. Use this to create a relationship to this DMEntity, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid- the GUID of the DMEntity to referencesemantic- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a DMEntity that can be used for defining a relationship to a DMEntity
-
refByQualifiedName
Reference to a DMEntity by qualifiedName. Use this to create a relationship to this DMEntity, where the relationship should be replaced.- Parameters:
qualifiedName- the qualifiedName of the DMEntity to reference- Returns:
- reference to a DMEntity that can be used for defining a relationship to a DMEntity
-
refByQualifiedName
Reference to a DMEntity by qualifiedName. Use this to create a relationship to this DMEntity, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName- the qualifiedName of the DMEntity to referencesemantic- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a DMEntity that can be used for defining a relationship to a DMEntity
-
get
Retrieves a DMEntity by one of its identifiers, complete with all of its relationships.- Parameters:
id- of the DMEntity to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full DMEntity, complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the DMEntity does not exist or the provided GUID is not a DMEntity
-
get
Retrieves a DMEntity 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 DMEntity to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full DMEntity, complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the DMEntity does not exist or the provided GUID is not a DMEntity
-
get
public static DMEntity get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a DMEntity 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 DMEntity 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 DMEntity, optionally complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the DMEntity does not exist or the provided GUID is not a DMEntity
-
restore
Restore the archived (soft-deleted) DMEntity to active.- Parameters:
qualifiedName- for the DMEntity- Returns:
- true if the DMEntity is now active, and false otherwise
- Throws:
AtlanException- on any API problems
-
restore
Restore the archived (soft-deleted) DMEntity to active.- Parameters:
client- connectivity to the Atlan tenant on which to restore the assetqualifiedName- for the DMEntity- Returns:
- true if the DMEntity is now active, and false otherwise
- Throws:
AtlanException- on any API problems
-
updater
Builds the minimal object necessary to update a DMEntity.- Parameters:
qualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the minimal request necessary to update the DMEntity, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a DMEntity, from a potentially more-complete DMEntity object.- Overrides:
trimToRequiredin classAsset- Returns:
- the minimal object necessary to update the DMEntity, as a builder
- Throws:
InvalidRequestException- if any of the minimal set of required properties for DMEntity are not found in the initial object
-
removeDescription
Remove the system description from a DMEntity.- Parameters:
qualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeDescription
public static DMEntity removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a DMEntity.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeUserDescription
public static DMEntity removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a DMEntity.- Parameters:
qualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeUserDescription
public static DMEntity removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a DMEntity.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeOwners
Remove the owners from a DMEntity.- Parameters:
qualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeOwners
public static DMEntity removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a DMEntity.- Parameters:
client- connectivity to the Atlan tenant from which to remove the DMEntity's ownersqualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateCertificate
public static DMEntity updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a DMEntity.- Parameters:
qualifiedName- of the DMEntitycertificate- to usemessage- (optional) message, or null if no message- Returns:
- the updated DMEntity, or null if the update failed
- Throws:
AtlanException- on any API problems
-
updateCertificate
public static DMEntity updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a DMEntity.- Parameters:
client- connectivity to the Atlan tenant on which to update the DMEntity's certificatequalifiedName- of the DMEntitycertificate- to usemessage- (optional) message, or null if no message- Returns:
- the updated DMEntity, or null if the update failed
- Throws:
AtlanException- on any API problems
-
removeCertificate
Remove the certificate from a DMEntity.- Parameters:
qualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeCertificate
public static DMEntity removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a DMEntity.- Parameters:
client- connectivity to the Atlan tenant from which to remove the DMEntity's certificatequalifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateAnnouncement
public static DMEntity updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a DMEntity.- Parameters:
qualifiedName- of the DMEntitytype- 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 DMEntity updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a DMEntity.- Parameters:
client- connectivity to the Atlan tenant on which to update the DMEntity's announcementqualifiedName- of the DMEntitytype- 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
Remove the announcement from a DMEntity.- Parameters:
qualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeAnnouncement
public static DMEntity removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a DMEntity.- Parameters:
client- connectivity to the Atlan client from which to remove the DMEntity's announcementqualifiedName- of the DMEntityname- of the DMEntity- Returns:
- the updated DMEntity, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
replaceTerms
public static DMEntity replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the DMEntity.- Parameters:
qualifiedName- for the DMEntityname- human-readable name of the DMEntityterms- the list of terms to replace on the DMEntity, or null to remove all terms from the DMEntity- Returns:
- the DMEntity that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException- on any API problems
-
replaceTerms
public static DMEntity replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the DMEntity.- Parameters:
client- connectivity to the Atlan tenant on which to replace the DMEntity's assigned termsqualifiedName- for the DMEntityname- human-readable name of the DMEntityterms- the list of terms to replace on the DMEntity, or null to remove all terms from the DMEntity- Returns:
- the DMEntity that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException- on any API problems
-
appendTerms
public static DMEntity appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the DMEntity, without replacing existing terms linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity's existing terms, and a second to append the new terms.- Parameters:
qualifiedName- for the DMEntityterms- the list of terms to append to the DMEntity- Returns:
- the DMEntity that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException- on any API problems
-
appendTerms
public static DMEntity appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the DMEntity, without replacing existing terms linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity'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 DMEntityqualifiedName- for the DMEntityterms- the list of terms to append to the DMEntity- Returns:
- the DMEntity that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException- on any API problems
-
removeTerms
public static DMEntity removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a DMEntity, without replacing all existing terms linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName- for the DMEntityterms- the list of terms to remove from the DMEntity, which must be referenced by GUID- Returns:
- the DMEntity that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException- on any API problems
-
removeTerms
public static DMEntity removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a DMEntity, without replacing all existing terms linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity'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 DMEntityqualifiedName- for the DMEntityterms- the list of terms to remove from the DMEntity, which must be referenced by GUID- Returns:
- the DMEntity that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
public static DMEntity appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName- of the DMEntityatlanTagNames- human-readable names of the Atlan tags to add- Returns:
- the updated DMEntity
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
public static DMEntity appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity'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 DMEntityqualifiedName- of the DMEntityatlanTagNames- human-readable names of the Atlan tags to add- Returns:
- the updated DMEntity
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
public static DMEntity appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName- of the DMEntityatlanTagNames- 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 DMEntity
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
public static DMEntity appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a DMEntity, without replacing existing Atlan tags linked to the DMEntity. Note: this operation must make two API calls — one to retrieve the DMEntity'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 DMEntityqualifiedName- of the DMEntityatlanTagNames- 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 DMEntity
- Throws:
AtlanException- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a DMEntity.- Parameters:
qualifiedName- of the DMEntityatlanTagName- 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 DMEntity
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a DMEntity.- Parameters:
client- connectivity to the Atlan tenant from which to remove an Atlan tag from a DMEntityqualifiedName- of the DMEntityatlanTagName- 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 DMEntity
-
_internal
-
toBuilder
-
getDmAttributeCount
Number of attributes in the entity.- Specified by:
getDmAttributeCountin interfaceIDMEntity
-
getDmAttributes
Individual attributes that make up the entity.- Specified by:
getDmAttributesin interfaceIDMEntity
-
getDmBusinessDate
Business date for the asset.- Specified by:
getDmBusinessDatein interfaceIDM- Specified by:
getDmBusinessDatein interfaceIDMEntity
-
getDmDataModelDomain
A domain of the data model in which this asset exists.- Specified by:
getDmDataModelDomainin interfaceIDM- Specified by:
getDmDataModelDomainin interfaceIDMEntity
-
getDmDataModelName
Simple name of the model in which this asset exists, or empty if it is itself a data model.- Specified by:
getDmDataModelNamein interfaceIDM- Specified by:
getDmDataModelNamein interfaceIDMEntity
-
getDmDataModelNamespace
A namespace of the data model in which this asset exists.- Specified by:
getDmDataModelNamespacein interfaceIDM- Specified by:
getDmDataModelNamespacein interfaceIDMEntity
-
getDmDataModelQualifiedName
Unique name of the model in which this asset exists, or empty if it is itself a data model.- Specified by:
getDmDataModelQualifiedNamein interfaceIDM- Specified by:
getDmDataModelQualifiedNamein interfaceIDMEntity
-
getDmEntityName
Simple name of the entity in which this asset exists, or empty if it is itself a data model entity.- Specified by:
getDmEntityNamein interfaceIDM- Specified by:
getDmEntityNamein interfaceIDMEntity
-
getDmEntityQualifiedName
Unique name of the entity in which this asset exists, or empty if it is itself a data model entity.- Specified by:
getDmEntityQualifiedNamein interfaceIDM- Specified by:
getDmEntityQualifiedNamein interfaceIDMEntity
-
getDmEntityType
Type of the data entity.- Specified by:
getDmEntityTypein interfaceIDMEntity
-
getDmExpiredAtBusinessDate
Business expiration date for the asset.- Specified by:
getDmExpiredAtBusinessDatein interfaceIDM- Specified by:
getDmExpiredAtBusinessDatein interfaceIDMEntity
-
getDmExpiredAtSystemDate
System expiration date for the asset.- Specified by:
getDmExpiredAtSystemDatein interfaceIDM- Specified by:
getDmExpiredAtSystemDatein interfaceIDMEntity
-
getDmMappedFromEntities
Entities from which this entity is mapped.- Specified by:
getDmMappedFromEntitiesin interfaceIDMEntity
-
getDmMappedToEntities
Entities to which this entity is mapped.- Specified by:
getDmMappedToEntitiesin interfaceIDMEntity
-
getDmRelatedFromEntities
Association from this entity is related.- Specified by:
getDmRelatedFromEntitiesin interfaceIDMEntity
-
getDmRelatedToEntities
Association to which this entity is related.- Specified by:
getDmRelatedToEntitiesin interfaceIDMEntity
-
getDmSubjectArea
Subject area of the entity.- Specified by:
getDmSubjectAreain interfaceIDMEntity
-
getDmSystemDate
System date for the asset.- Specified by:
getDmSystemDatein interfaceIDM- Specified by:
getDmSystemDatein interfaceIDMEntity
-
getDmVersionName
Simple name of the version in which this asset exists, or empty if it is itself a data model version.- Specified by:
getDmVersionNamein interfaceIDM- Specified by:
getDmVersionNamein interfaceIDMEntity
-
getDmVersionQualifiedName
Unique name of the version in which this asset exists, or empty if it is itself a data model version.- Specified by:
getDmVersionQualifiedNamein interfaceIDM- Specified by:
getDmVersionQualifiedNamein interfaceIDMEntity
-
getDmVersions
Data model version(s) in which this entity exists.- Specified by:
getDmVersionsin interfaceIDMEntity
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasksin interfaceICatalog- Specified by:
getInputToAirflowTasksin interfaceIDM- Specified by:
getInputToAirflowTasksin interfaceIDMEntity
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcessesin interfaceICatalog- Specified by:
getInputToProcessesin interfaceIDM- Specified by:
getInputToProcessesin interfaceIDMEntity
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobsin interfaceICatalog- Specified by:
getInputToSparkJobsin interfaceIDM- Specified by:
getInputToSparkJobsin interfaceIDMEntity
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasksin interfaceICatalog- Specified by:
getOutputFromAirflowTasksin interfaceIDM- Specified by:
getOutputFromAirflowTasksin interfaceIDMEntity
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcessesin interfaceICatalog- Specified by:
getOutputFromProcessesin interfaceIDM- Specified by:
getOutputFromProcessesin interfaceIDMEntity
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobsin interfaceICatalog- Specified by:
getOutputFromSparkJobsin interfaceIDM- Specified by:
getOutputFromSparkJobsin interfaceIDMEntity
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject -
getTypeName
Fixed typeName for DMEntitys.- Specified by:
getTypeNamein interfaceAuditDetail- Specified by:
getTypeNamein interfaceIAsset- Specified by:
getTypeNamein interfaceICatalog- Specified by:
getTypeNamein interfaceIDM- Specified by:
getTypeNamein interfaceIDMEntity- Specified by:
getTypeNamein interfaceIReferenceable- Overrides:
getTypeNamein classReference
-