Package com.atlan.model.assets
Class ModelVersion
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.ModelVersion
- All Implemented Interfaces:
IAsset
,ICatalog
,IModel
,IModelVersion
,IReferenceable
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class ModelVersion
extends Asset
implements IModelVersion, IModel, ICatalog, IAsset, IReferenceable
Instance of a version of a data model in Atlan.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
ModelVersion.ModelVersionBuilder<C extends ModelVersion,
B extends ModelVersion.ModelVersionBuilder<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.IModel
MODEL_BUSINESS_DATE, MODEL_DOMAIN, MODEL_ENTITY_NAME, MODEL_ENTITY_QUALIFIED_NAME, MODEL_EXPIRED_AT_BUSINESS_DATE, MODEL_EXPIRED_AT_SYSTEM_DATE, MODEL_NAME, MODEL_NAMESPACE, MODEL_QUALIFIED_NAME, MODEL_SYSTEM_DATE, MODEL_TYPE, MODEL_VERSION_AGNOSTIC_QUALIFIED_NAME, MODEL_VERSION_NAME, MODEL_VERSION_QUALIFIED_NAME
Fields inherited from interface com.atlan.model.assets.IModelVersion
MODEL_DATA_MODEL, MODEL_VERSION_ENTITIES, MODEL_VERSION_ENTITY_COUNT
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 ModelVersion.ModelVersionBuilder<?,
?> static ModelVersion
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion.static ModelVersion
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion.static ModelVersion
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion.static ModelVersion
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion.static ModelVersion
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the ModelVersion, without replacing existing terms linked to the ModelVersion.static ModelVersion
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the ModelVersion, without replacing existing terms linked to the ModelVersion.protected boolean
static ModelVersion.ModelVersionBuilder<?,
?> creator
(String name, ModelDataModel model) Builds the minimal object necessary to create a ModelVersion.static ModelVersion.ModelVersionBuilder<?,
?> Builds the minimal object necessary to create a ModelVersion.static ModelVersion.ModelVersionBuilder<?,
?> Builds the minimal object necessary to create a ModelVersion.boolean
static String
generateQualifiedName
(String name, String modelQualifiedName) Generate a unique ModelVersion name.static ModelVersion
get
(AtlanClient client, String id) Retrieves a ModelVersion by one of its identifiers, complete with all of its relationships.static ModelVersion
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a ModelVersion by one of its identifiers, optionally complete with all of its relationships.static ModelVersion
Retrieves a ModelVersion 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.Tasks to which this asset provides input.Processes to which this asset provides input.TBCBusiness date for the asset.Data model for which this version exists.Model domain in which this asset exists.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.Business expiration date for the asset.System expiration date for the asset.Entities implemented by this asset.Simple name of the model in which this asset exists, or empty if it is itself a data model.Model namespace in which this asset exists.Unique name of the model in which this asset exists, or empty if it is itself a data model.System date for the asset.Type of the model asset (conceptual, logical, physical).Unique name of the parent in which this asset exists, irrespective of the version (always implies the latest version).Individual entities that make up this version of the data model.Number of entities in the version.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.Tasks from which this asset is output.Processes from which this asset is produced as output.TBCFixed typeName for ModelVersions.int
hashCode()
static ModelVersion
Reference to a ModelVersion by GUID.static ModelVersion
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a ModelVersion by GUID.static ModelVersion
refByQualifiedName
(String qualifiedName) Reference to a ModelVersion by qualifiedName.static ModelVersion
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a ModelVersion by qualifiedName.static ModelVersion
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a ModelVersion.static ModelVersion
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a ModelVersion.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a ModelVersion.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a ModelVersion.static ModelVersion
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a ModelVersion.static ModelVersion
removeCertificate
(String qualifiedName, String name) Remove the certificate from a ModelVersion.static ModelVersion
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a ModelVersion.static ModelVersion
removeDescription
(String qualifiedName, String name) Remove the system description from a ModelVersion.static ModelVersion
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a ModelVersion.static ModelVersion
removeOwners
(String qualifiedName, String name) Remove the owners from a ModelVersion.static ModelVersion
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a ModelVersion, without replacing all existing terms linked to the ModelVersion.static ModelVersion
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a ModelVersion, without replacing all existing terms linked to the ModelVersion.static ModelVersion
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a ModelVersion.static ModelVersion
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a ModelVersion.static ModelVersion
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the ModelVersion.static ModelVersion
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the ModelVersion.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) ModelVersion to active.static boolean
Restore the archived (soft-deleted) ModelVersion to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all ModelVersion assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all ModelVersion assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all ModelVersion assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all ModelVersion assets.toString()
Builds the minimal object necessary to create a relationship to a ModelVersion, from a potentially more-complete ModelVersion object.Builds the minimal object necessary to apply an update to a ModelVersion, from a potentially more-complete ModelVersion object.static ModelVersion
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a ModelVersion.static ModelVersion
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a ModelVersion.static ModelVersion
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a ModelVersion.static ModelVersion
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a ModelVersion.static ModelVersion.ModelVersionBuilder<?,
?> Builds the minimal object necessary to update a ModelVersion.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.IModel
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.IModelVersion
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
-
ModelVersion
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a ModelVersion, from a potentially more-complete ModelVersion object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the ModelVersion
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a ModelVersion relationship are not found in the initial object
-
select
Start a fluent search that will return all ModelVersion 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) ModelVersion assets will be included.- Returns:
- a fluent search that includes all ModelVersion assets
-
select
Start a fluent search that will return all ModelVersion 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) ModelVersion assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all ModelVersion assets
-
select
Start a fluent search that will return all ModelVersion 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) ModelVersions will be included- Returns:
- a fluent search that includes all ModelVersion assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all ModelVersion 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) ModelVersions will be included- Returns:
- a fluent search that includes all ModelVersion assets
-
refByGuid
Reference to a ModelVersion by GUID. Use this to create a relationship to this ModelVersion, where the relationship should be replaced.- Parameters:
guid
- the GUID of the ModelVersion to reference- Returns:
- reference to a ModelVersion that can be used for defining a relationship to a ModelVersion
-
refByGuid
Reference to a ModelVersion by GUID. Use this to create a relationship to this ModelVersion, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the ModelVersion to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a ModelVersion that can be used for defining a relationship to a ModelVersion
-
refByQualifiedName
Reference to a ModelVersion by qualifiedName. Use this to create a relationship to this ModelVersion, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the ModelVersion to reference- Returns:
- reference to a ModelVersion that can be used for defining a relationship to a ModelVersion
-
refByQualifiedName
public static ModelVersion refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a ModelVersion by qualifiedName. Use this to create a relationship to this ModelVersion, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the ModelVersion to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a ModelVersion that can be used for defining a relationship to a ModelVersion
-
get
Retrieves a ModelVersion by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the ModelVersion to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full ModelVersion, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the ModelVersion does not exist or the provided GUID is not a ModelVersion
-
get
Retrieves a ModelVersion 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 ModelVersion to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full ModelVersion, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the ModelVersion does not exist or the provided GUID is not a ModelVersion
-
get
public static ModelVersion get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a ModelVersion 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 ModelVersion 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 ModelVersion, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the ModelVersion does not exist or the provided GUID is not a ModelVersion
-
restore
Restore the archived (soft-deleted) ModelVersion to active.- Parameters:
qualifiedName
- for the ModelVersion- Returns:
- true if the ModelVersion is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) ModelVersion to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the ModelVersion- Returns:
- true if the ModelVersion is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
creator
public static ModelVersion.ModelVersionBuilder<?,?> creator(String name, ModelDataModel model) throws InvalidRequestException Builds the minimal object necessary to create a ModelVersion.- Parameters:
name
- of the ModelVersionmodel
- in which the version should be created, which must have at least a qualifiedName- Returns:
- the minimal request necessary to create the ModelVersion, as a builder
- Throws:
InvalidRequestException
- if the model provided is without a qualifiedName
-
creator
Builds the minimal object necessary to create a ModelVersion.- Parameters:
name
- of the ModelVersionmodelQualifiedName
- unique name of the model in which this ModelVersion exists- Returns:
- the minimal request necessary to create the ModelVersion, as a builder
-
creator
public static ModelVersion.ModelVersionBuilder<?,?> creator(String name, String connectionQualifiedName, String modelName, String modelQualifiedName) Builds the minimal object necessary to create a ModelVersion.- Parameters:
name
- of the ModelVersionconnectionQualifiedName
- unique name of the connection in which to create this ModelVersionmodelName
- simple name of the model in which to create this ModelVersionmodelQualifiedName
- unique name of the model in which to create this ModelVersion- Returns:
- the minimal request necessary to create the ModelVersion, as a builder
-
updater
Builds the minimal object necessary to update a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the minimal request necessary to update the ModelVersion, as a builder
-
generateQualifiedName
Generate a unique ModelVersion name.- Parameters:
name
- of the ModelVersionmodelQualifiedName
- unique name of the model in which this ModelVersion exists- Returns:
- a unique name for the ModelVersion
-
trimToRequired
Builds the minimal object necessary to apply an update to a ModelVersion, from a potentially more-complete ModelVersion object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the ModelVersion, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for ModelVersion are not found in the initial object
-
removeDescription
public static ModelVersion removeDescription(String qualifiedName, String name) throws AtlanException Remove the system description from a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static ModelVersion removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static ModelVersion removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static ModelVersion removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static ModelVersion removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the ModelVersion's ownersqualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static ModelVersion updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersioncertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated ModelVersion, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static ModelVersion updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant on which to update the ModelVersion's certificatequalifiedName
- of the ModelVersioncertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated ModelVersion, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static ModelVersion removeCertificate(String qualifiedName, String name) throws AtlanException Remove the certificate from a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static ModelVersion removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the ModelVersion's certificatequalifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static ModelVersion updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersiontype
- 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 ModelVersion updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant on which to update the ModelVersion's announcementqualifiedName
- of the ModelVersiontype
- 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 ModelVersion removeAnnouncement(String qualifiedName, String name) throws AtlanException Remove the announcement from a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static ModelVersion removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a ModelVersion.- Parameters:
client
- connectivity to the Atlan client from which to remove the ModelVersion's announcementqualifiedName
- of the ModelVersionname
- of the ModelVersion- Returns:
- the updated ModelVersion, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static ModelVersion replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the ModelVersion.- Parameters:
qualifiedName
- for the ModelVersionname
- human-readable name of the ModelVersionterms
- the list of terms to replace on the ModelVersion, or null to remove all terms from the ModelVersion- Returns:
- the ModelVersion that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static ModelVersion replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the ModelVersion's assigned termsqualifiedName
- for the ModelVersionname
- human-readable name of the ModelVersionterms
- the list of terms to replace on the ModelVersion, or null to remove all terms from the ModelVersion- Returns:
- the ModelVersion that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static ModelVersion appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the ModelVersion, without replacing existing terms linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the ModelVersionterms
- the list of terms to append to the ModelVersion- Returns:
- the ModelVersion that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static ModelVersion appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the ModelVersion, without replacing existing terms linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion'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 ModelVersionqualifiedName
- for the ModelVersionterms
- the list of terms to append to the ModelVersion- Returns:
- the ModelVersion that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static ModelVersion removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a ModelVersion, without replacing all existing terms linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the ModelVersionterms
- the list of terms to remove from the ModelVersion, which must be referenced by GUID- Returns:
- the ModelVersion that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static ModelVersion removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a ModelVersion, without replacing all existing terms linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion'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 ModelVersionqualifiedName
- for the ModelVersionterms
- the list of terms to remove from the ModelVersion, which must be referenced by GUID- Returns:
- the ModelVersion that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static ModelVersion appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the ModelVersionatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated ModelVersion
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static ModelVersion appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion'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 ModelVersionqualifiedName
- of the ModelVersionatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated ModelVersion
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static ModelVersion appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the ModelVersionatlanTagNames
- 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 ModelVersion
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static ModelVersion appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a ModelVersion, without replacing existing Atlan tags linked to the ModelVersion. Note: this operation must make two API calls — one to retrieve the ModelVersion'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 ModelVersionqualifiedName
- of the ModelVersionatlanTagNames
- 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 ModelVersion
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a ModelVersion.- Parameters:
qualifiedName
- of the ModelVersionatlanTagName
- 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 ModelVersion
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a ModelVersion.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a ModelVersionqualifiedName
- of the ModelVersionatlanTagName
- 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 ModelVersion
-
_internal
-
toBuilder
-
getApplicationContainer
ApplicationContainer asset containing this Catalog asset.- Specified by:
getApplicationContainer
in interfaceICatalog
- Specified by:
getApplicationContainer
in interfaceIModel
- Specified by:
getApplicationContainer
in interfaceIModelVersion
-
getAssetApplicationQualifiedName
Qualified name of the Application Container that contains this asset.- Specified by:
getAssetApplicationQualifiedName
in interfaceICatalog
- Specified by:
getAssetApplicationQualifiedName
in interfaceIModel
- Specified by:
getAssetApplicationQualifiedName
in interfaceIModelVersion
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasks
in interfaceICatalog
- Specified by:
getInputToAirflowTasks
in interfaceIModel
- Specified by:
getInputToAirflowTasks
in interfaceIModelVersion
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcesses
in interfaceICatalog
- Specified by:
getInputToProcesses
in interfaceIModel
- Specified by:
getInputToProcesses
in interfaceIModelVersion
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobs
in interfaceICatalog
- Specified by:
getInputToSparkJobs
in interfaceIModel
- Specified by:
getInputToSparkJobs
in interfaceIModelVersion
-
getModelBusinessDate
Business date for the asset.- Specified by:
getModelBusinessDate
in interfaceIModel
- Specified by:
getModelBusinessDate
in interfaceIModelVersion
-
getModelDataModel
Data model for which this version exists.- Specified by:
getModelDataModel
in interfaceIModelVersion
-
getModelDomain
Model domain in which this asset exists.- Specified by:
getModelDomain
in interfaceIModel
- Specified by:
getModelDomain
in interfaceIModelVersion
-
getModelEntityName
Simple name of the entity in which this asset exists, or empty if it is itself a data model entity.- Specified by:
getModelEntityName
in interfaceIModel
- Specified by:
getModelEntityName
in interfaceIModelVersion
-
getModelEntityQualifiedName
Unique name of the entity in which this asset exists, or empty if it is itself a data model entity.- Specified by:
getModelEntityQualifiedName
in interfaceIModel
- Specified by:
getModelEntityQualifiedName
in interfaceIModelVersion
-
getModelExpiredAtBusinessDate
Business expiration date for the asset.- Specified by:
getModelExpiredAtBusinessDate
in interfaceIModel
- Specified by:
getModelExpiredAtBusinessDate
in interfaceIModelVersion
-
getModelExpiredAtSystemDate
System expiration date for the asset.- Specified by:
getModelExpiredAtSystemDate
in interfaceIModel
- Specified by:
getModelExpiredAtSystemDate
in interfaceIModelVersion
-
getModelImplementedEntities
Entities implemented by this asset.- Specified by:
getModelImplementedEntities
in interfaceICatalog
- Specified by:
getModelImplementedEntities
in interfaceIModel
- Specified by:
getModelImplementedEntities
in interfaceIModelVersion
-
getModelName
Simple name of the model in which this asset exists, or empty if it is itself a data model.- Specified by:
getModelName
in interfaceIModel
- Specified by:
getModelName
in interfaceIModelVersion
-
getModelNamespace
Model namespace in which this asset exists.- Specified by:
getModelNamespace
in interfaceIModel
- Specified by:
getModelNamespace
in interfaceIModelVersion
-
getModelQualifiedName
Unique name of the model in which this asset exists, or empty if it is itself a data model.- Specified by:
getModelQualifiedName
in interfaceIModel
- Specified by:
getModelQualifiedName
in interfaceIModelVersion
-
getModelSystemDate
System date for the asset.- Specified by:
getModelSystemDate
in interfaceIModel
- Specified by:
getModelSystemDate
in interfaceIModelVersion
-
getModelType
Type of the model asset (conceptual, logical, physical).- Specified by:
getModelType
in interfaceIModel
- Specified by:
getModelType
in interfaceIModelVersion
-
getModelVersionAgnosticQualifiedName
Unique name of the parent in which this asset exists, irrespective of the version (always implies the latest version).- Specified by:
getModelVersionAgnosticQualifiedName
in interfaceIModel
- Specified by:
getModelVersionAgnosticQualifiedName
in interfaceIModelVersion
-
getModelVersionEntities
Individual entities that make up this version of the data model.- Specified by:
getModelVersionEntities
in interfaceIModelVersion
-
getModelVersionEntityCount
Number of entities in the version.- Specified by:
getModelVersionEntityCount
in interfaceIModelVersion
-
getModelVersionName
Simple name of the version in which this asset exists, or empty if it is itself a data model version.- Specified by:
getModelVersionName
in interfaceIModel
- Specified by:
getModelVersionName
in interfaceIModelVersion
-
getModelVersionQualifiedName
Unique name of the version in which this asset exists, or empty if it is itself a data model version.- Specified by:
getModelVersionQualifiedName
in interfaceIModel
- Specified by:
getModelVersionQualifiedName
in interfaceIModelVersion
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasks
in interfaceICatalog
- Specified by:
getOutputFromAirflowTasks
in interfaceIModel
- Specified by:
getOutputFromAirflowTasks
in interfaceIModelVersion
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcesses
in interfaceICatalog
- Specified by:
getOutputFromProcesses
in interfaceIModel
- Specified by:
getOutputFromProcesses
in interfaceIModelVersion
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobs
in interfaceICatalog
- Specified by:
getOutputFromSparkJobs
in interfaceIModel
- Specified by:
getOutputFromSparkJobs
in interfaceIModelVersion
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for ModelVersions.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceICatalog
- Specified by:
getTypeName
in interfaceIModel
- Specified by:
getTypeName
in interfaceIModelVersion
- Specified by:
getTypeName
in interfaceIReferenceable
- Overrides:
getTypeName
in classReference
-