Package com.atlan.model.assets
Class DataContract
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.DataContract
- All Implemented Interfaces:
IAsset
,ICatalog
,IDataContract
,IReferenceable
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class DataContract
extends Asset
implements IDataContract, ICatalog, IAsset, IReferenceable
Data contract for an asset.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
DataContract.DataContractBuilder<C extends DataContract,
B extends DataContract.DataContractBuilder<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.IDataContract
DATA_CONTRACT_ASSET_CERTIFIED, DATA_CONTRACT_ASSET_GUID, DATA_CONTRACT_ASSET_LATEST, DATA_CONTRACT_JSON, DATA_CONTRACT_NEXT_VERSION, DATA_CONTRACT_PREVIOUS_VERSION, DATA_CONTRACT_SPEC, DATA_CONTRACT_VERSION
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 DataContract.DataContractBuilder<?,
?> static DataContract
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract.static DataContract
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract.static DataContract
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract.static DataContract
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract.static DataContract
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the DataContract, without replacing existing terms linked to the DataContract.static DataContract
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the DataContract, without replacing existing terms linked to the DataContract.protected boolean
static DataContract.DataContractBuilder<?,
?> Builds the minimal object necessary to create a DataContract.static DataContract.DataContractBuilder<?,
?> Builds the minimal object necessary to create a DataContract.static DataContract.DataContractBuilder<?,
?> Builds the minimal object necessary to create a DataContract.boolean
static String
generateQualifiedName
(String assetQualifiedName) Generate a unique DataContract name.static DataContract
get
(AtlanClient client, String id) Retrieves a DataContract by one of its identifiers, complete with all of its relationships.static DataContract
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a DataContract by one of its identifiers, optionally complete with all of its relationships.static DataContract
Retrieves a DataContract 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.Asset this contract controls.Unique identifier of the asset associated with this data contract.Asset this contract controls or will control.(Deprecated) Replaced by dataContractSpec attribute.Data contract instance that holds the next version of this contract.Data contract instance that holds the previous version of this contract.Actual content of the contract in YAML string format.Version of the contract.Tasks to which this asset provides input.Processes to which this asset provides input.TBCEntities implemented by this asset.Tasks from which this asset is output.Processes from which this asset is produced as output.TBCFixed typeName for DataContracts.int
hashCode()
static DataContract
Reference to a DataContract by GUID.static DataContract
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a DataContract by GUID.static DataContract
refByQualifiedName
(String qualifiedName) Reference to a DataContract by qualifiedName.static DataContract
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a DataContract by qualifiedName.static DataContract
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a DataContract.static DataContract
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a DataContract.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a DataContract.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a DataContract.static DataContract
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a DataContract.static DataContract
removeCertificate
(String qualifiedName, String name) Remove the certificate from a DataContract.static DataContract
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a DataContract.static DataContract
removeDescription
(String qualifiedName, String name) Remove the system description from a DataContract.static DataContract
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a DataContract.static DataContract
removeOwners
(String qualifiedName, String name) Remove the owners from a DataContract.static DataContract
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a DataContract, without replacing all existing terms linked to the DataContract.static DataContract
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a DataContract, without replacing all existing terms linked to the DataContract.static DataContract
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a DataContract.static DataContract
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a DataContract.static DataContract
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the DataContract.static DataContract
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the DataContract.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) DataContract to active.static boolean
Restore the archived (soft-deleted) DataContract to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all DataContract assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all DataContract assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all DataContract assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all DataContract assets.toString()
Builds the minimal object necessary to create a relationship to a DataContract, from a potentially more-complete DataContract object.Builds the minimal object necessary to apply an update to a DataContract, from a potentially more-complete DataContract object.static DataContract
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a DataContract.static DataContract
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a DataContract.static DataContract
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a DataContract.static DataContract
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a DataContract.static DataContract.DataContractBuilder<?,
?> Builds the minimal object necessary to update a DataContract.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.IDataContract
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
-
DataContract
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a DataContract, from a potentially more-complete DataContract object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the DataContract
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a DataContract relationship are not found in the initial object
-
select
Start a fluent search that will return all DataContract 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) DataContract assets will be included.- Returns:
- a fluent search that includes all DataContract assets
-
select
Start a fluent search that will return all DataContract 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) DataContract assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all DataContract assets
-
select
Start a fluent search that will return all DataContract 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) DataContracts will be included- Returns:
- a fluent search that includes all DataContract assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all DataContract 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) DataContracts will be included- Returns:
- a fluent search that includes all DataContract assets
-
refByGuid
Reference to a DataContract by GUID. Use this to create a relationship to this DataContract, where the relationship should be replaced.- Parameters:
guid
- the GUID of the DataContract to reference- Returns:
- reference to a DataContract that can be used for defining a relationship to a DataContract
-
refByGuid
Reference to a DataContract by GUID. Use this to create a relationship to this DataContract, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the DataContract to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a DataContract that can be used for defining a relationship to a DataContract
-
refByQualifiedName
Reference to a DataContract by qualifiedName. Use this to create a relationship to this DataContract, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the DataContract to reference- Returns:
- reference to a DataContract that can be used for defining a relationship to a DataContract
-
refByQualifiedName
public static DataContract refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a DataContract by qualifiedName. Use this to create a relationship to this DataContract, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the DataContract to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a DataContract that can be used for defining a relationship to a DataContract
-
get
Retrieves a DataContract by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the DataContract to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full DataContract, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the DataContract does not exist or the provided GUID is not a DataContract
-
get
Retrieves a DataContract 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 DataContract to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full DataContract, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the DataContract does not exist or the provided GUID is not a DataContract
-
get
public static DataContract get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a DataContract 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 DataContract 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 DataContract, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the DataContract does not exist or the provided GUID is not a DataContract
-
restore
Restore the archived (soft-deleted) DataContract to active.- Parameters:
qualifiedName
- for the DataContract- Returns:
- true if the DataContract is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) DataContract to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the DataContract- Returns:
- true if the DataContract is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
creator
public static DataContract.DataContractBuilder<?,?> creator(String contract, Asset asset) throws InvalidRequestException Builds the minimal object necessary to create a DataContract.- Parameters:
contract
- detailed specification of the contractasset
- asset for which to create this contract- Returns:
- the minimal request necessary to create the DataContract, as a builder
- Throws:
InvalidRequestException
- if the asset provided is without some required information
-
creator
public static DataContract.DataContractBuilder<?,?> creator(String contract, String assetQualifiedName) Builds the minimal object necessary to create a DataContract.- Parameters:
contract
- detailed specification of the contractassetQualifiedName
- unique name of the asset for which to create this contract- Returns:
- the minimal request necessary to create the DataContract, as a builder
-
creator
public static DataContract.DataContractBuilder<?,?> creator(String contract, String assetName, String assetQualifiedName) Builds the minimal object necessary to create a DataContract.- Parameters:
contract
- detailed specification of the contractassetName
- simple name of the asset for which to create this contractassetQualifiedName
- unique name of the asset for which to create this contract- Returns:
- the minimal request necessary to create the DataContract, as a builder
-
updater
Builds the minimal object necessary to update a DataContract.- Parameters:
qualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the minimal request necessary to update the DataContract, as a builder
-
generateQualifiedName
Generate a unique DataContract name.- Parameters:
assetQualifiedName
- unique name of the asset for which this DataContract exists- Returns:
- a unique name for the DataContract
-
trimToRequired
Builds the minimal object necessary to apply an update to a DataContract, from a potentially more-complete DataContract object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the DataContract, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for DataContract are not found in the initial object
-
removeDescription
public static DataContract removeDescription(String qualifiedName, String name) throws AtlanException Remove the system description from a DataContract.- Parameters:
qualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static DataContract removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a DataContract.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static DataContract removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a DataContract.- Parameters:
qualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static DataContract removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a DataContract.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a DataContract.- Parameters:
qualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static DataContract removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a DataContract.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the DataContract's ownersqualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static DataContract updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a DataContract.- Parameters:
qualifiedName
- of the DataContractcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated DataContract, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static DataContract updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a DataContract.- Parameters:
client
- connectivity to the Atlan tenant on which to update the DataContract's certificatequalifiedName
- of the DataContractcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated DataContract, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static DataContract removeCertificate(String qualifiedName, String name) throws AtlanException Remove the certificate from a DataContract.- Parameters:
qualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static DataContract removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a DataContract.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the DataContract's certificatequalifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static DataContract updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a DataContract.- Parameters:
qualifiedName
- of the DataContracttype
- 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 DataContract updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a DataContract.- Parameters:
client
- connectivity to the Atlan tenant on which to update the DataContract's announcementqualifiedName
- of the DataContracttype
- 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 DataContract removeAnnouncement(String qualifiedName, String name) throws AtlanException Remove the announcement from a DataContract.- Parameters:
qualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static DataContract removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a DataContract.- Parameters:
client
- connectivity to the Atlan client from which to remove the DataContract's announcementqualifiedName
- of the DataContractname
- of the DataContract- Returns:
- the updated DataContract, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static DataContract replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the DataContract.- Parameters:
qualifiedName
- for the DataContractname
- human-readable name of the DataContractterms
- the list of terms to replace on the DataContract, or null to remove all terms from the DataContract- Returns:
- the DataContract that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static DataContract replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the DataContract.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the DataContract's assigned termsqualifiedName
- for the DataContractname
- human-readable name of the DataContractterms
- the list of terms to replace on the DataContract, or null to remove all terms from the DataContract- Returns:
- the DataContract that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static DataContract appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the DataContract, without replacing existing terms linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the DataContractterms
- the list of terms to append to the DataContract- Returns:
- the DataContract that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static DataContract appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the DataContract, without replacing existing terms linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract'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 DataContractqualifiedName
- for the DataContractterms
- the list of terms to append to the DataContract- Returns:
- the DataContract that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static DataContract removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a DataContract, without replacing all existing terms linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the DataContractterms
- the list of terms to remove from the DataContract, which must be referenced by GUID- Returns:
- the DataContract that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static DataContract removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a DataContract, without replacing all existing terms linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract'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 DataContractqualifiedName
- for the DataContractterms
- the list of terms to remove from the DataContract, which must be referenced by GUID- Returns:
- the DataContract that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataContract appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the DataContractatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated DataContract
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataContract appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract'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 DataContractqualifiedName
- of the DataContractatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated DataContract
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataContract appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the DataContractatlanTagNames
- 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 DataContract
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static DataContract appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a DataContract, without replacing existing Atlan tags linked to the DataContract. Note: this operation must make two API calls — one to retrieve the DataContract'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 DataContractqualifiedName
- of the DataContractatlanTagNames
- 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 DataContract
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a DataContract.- Parameters:
qualifiedName
- of the DataContractatlanTagName
- 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 DataContract
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a DataContract.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a DataContractqualifiedName
- of the DataContractatlanTagName
- 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 DataContract
-
_internal
-
toBuilder
-
getApplicationContainer
ApplicationContainer asset containing this Catalog asset.- Specified by:
getApplicationContainer
in interfaceICatalog
- Specified by:
getApplicationContainer
in interfaceIDataContract
-
getAssetApplicationQualifiedName
Qualified name of the Application Container that contains this asset.- Specified by:
getAssetApplicationQualifiedName
in interfaceICatalog
- Specified by:
getAssetApplicationQualifiedName
in interfaceIDataContract
-
getDataContractAssetCertified
Asset this contract controls.- Specified by:
getDataContractAssetCertified
in interfaceIDataContract
-
getDataContractAssetGuid
Unique identifier of the asset associated with this data contract.- Specified by:
getDataContractAssetGuid
in interfaceIDataContract
-
getDataContractAssetLatest
Asset this contract controls or will control.- Specified by:
getDataContractAssetLatest
in interfaceIDataContract
-
getDataContractJson
(Deprecated) Replaced by dataContractSpec attribute.- Specified by:
getDataContractJson
in interfaceIDataContract
-
getDataContractNextVersion
Data contract instance that holds the next version of this contract.- Specified by:
getDataContractNextVersion
in interfaceIDataContract
-
getDataContractPreviousVersion
Data contract instance that holds the previous version of this contract.- Specified by:
getDataContractPreviousVersion
in interfaceIDataContract
-
getDataContractSpec
Actual content of the contract in YAML string format. Any changes to this string should create a new instance (with new sequential version number).- Specified by:
getDataContractSpec
in interfaceIDataContract
-
getDataContractVersion
Version of the contract.- Specified by:
getDataContractVersion
in interfaceIDataContract
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasks
in interfaceICatalog
- Specified by:
getInputToAirflowTasks
in interfaceIDataContract
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcesses
in interfaceICatalog
- Specified by:
getInputToProcesses
in interfaceIDataContract
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobs
in interfaceICatalog
- Specified by:
getInputToSparkJobs
in interfaceIDataContract
-
getModelImplementedEntities
Entities implemented by this asset.- Specified by:
getModelImplementedEntities
in interfaceICatalog
- Specified by:
getModelImplementedEntities
in interfaceIDataContract
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasks
in interfaceICatalog
- Specified by:
getOutputFromAirflowTasks
in interfaceIDataContract
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcesses
in interfaceICatalog
- Specified by:
getOutputFromProcesses
in interfaceIDataContract
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobs
in interfaceICatalog
- Specified by:
getOutputFromSparkJobs
in interfaceIDataContract
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for DataContracts.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceICatalog
- Specified by:
getTypeName
in interfaceIDataContract
- Specified by:
getTypeName
in interfaceIReferenceable
- Overrides:
getTypeName
in classReference
-