Package com.atlan.model.assets
Class AdfDataset
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.AdfDataset
- All Implemented Interfaces:
IADF
,IAdfDataset
,IAsset
,ICatalog
,IReferenceable
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class AdfDataset
extends Asset
implements IAdfDataset, IADF, ICatalog, IAsset, IReferenceable
Base class for ADF Datasets. It is a named view of data that references or points to the data you want to use in activities.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
AdfDataset.AdfDatasetBuilder<C extends AdfDataset,
B extends AdfDataset.AdfDatasetBuilder<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.IADF
ADF_ASSET_FOLDER_PATH, ADF_FACTORY_NAME
Fields inherited from interface com.atlan.model.assets.IAdfDataset
ADF_ACTIVITIES, ADF_DATAFLOWS, ADF_DATASET_ANNOTATIONS, ADF_DATASET_COLLECTION_NAME, ADF_DATASET_CONTAINER_NAME, ADF_DATASET_DATABASE_NAME, ADF_DATASET_FILE_FOLDER_PATH, ADF_DATASET_FILE_NAME, ADF_DATASET_LINKED_SERVICE, ADF_DATASET_SCHEMA_NAME, ADF_DATASET_STORAGE_TYPE, ADF_DATASET_TABLE_NAME, ADF_DATASET_TYPE, ADF_LINKEDSERVICE, ADF_PIPELINES
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.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 AdfDataset.AdfDatasetBuilder<?,
?> static AdfDataset
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset.static AdfDataset
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset.static AdfDataset
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset.static AdfDataset
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset.static AdfDataset
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the AdfDataset, without replacing existing terms linked to the AdfDataset.static AdfDataset
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the AdfDataset, without replacing existing terms linked to the AdfDataset.protected boolean
boolean
static AdfDataset
get
(AtlanClient client, String id) Retrieves a AdfDataset by one of its identifiers, complete with all of its relationships.static AdfDataset
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a AdfDataset by one of its identifiers, optionally complete with all of its relationships.static AdfDataset
Retrieves a AdfDataset by one of its identifiers, complete with all of its relationships.ADF Dataset that is associated with these ADF activities.Defines the folder path in which this ADF asset exists.ADF Datasets that are associated with this ADF Dataflows.The list of annotation assigned to a dataset.Defines the name collection in the cosmos dataset.Defines the container or bucket name in the storage file system dataset.Defines the name of the database used in the azure delta lake type of dataset.Defines the folder path of the file in the storage file system dataset.Defines the name of the file in the storage file system dataset.Defines the name of the linked service used to create this dataset.Defines the name of the schema used in the snowflake, mssql, azure sql database type of dataset.Defines the storage type of storage file system dataset.Defines the name of the table used in the snowflake, mssql, azure sql database type of dataset.Defines the type of the dataset.Defines the name of the factory in which this asset exists.ADF datasets that are associated with this ADF Linkedservice.ADF Datasets that are associated with this ADF pipelines.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.TBCEntities implemented by this asset.Tasks from which this asset is output.Processes from which this asset is produced as output.TBCFixed typeName for AdfDatasets.int
hashCode()
static AdfDataset
Reference to a AdfDataset by GUID.static AdfDataset
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a AdfDataset by GUID.static AdfDataset
refByQualifiedName
(String qualifiedName) Reference to a AdfDataset by qualifiedName.static AdfDataset
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a AdfDataset by qualifiedName.static AdfDataset
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a AdfDataset.static AdfDataset
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a AdfDataset.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a AdfDataset.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a AdfDataset.static AdfDataset
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a AdfDataset.static AdfDataset
removeCertificate
(String qualifiedName, String name) Remove the certificate from a AdfDataset.static AdfDataset
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a AdfDataset.static AdfDataset
removeDescription
(String qualifiedName, String name) Remove the system description from a AdfDataset.static AdfDataset
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a AdfDataset.static AdfDataset
removeOwners
(String qualifiedName, String name) Remove the owners from a AdfDataset.static AdfDataset
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a AdfDataset, without replacing all existing terms linked to the AdfDataset.static AdfDataset
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a AdfDataset, without replacing all existing terms linked to the AdfDataset.static AdfDataset
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a AdfDataset.static AdfDataset
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a AdfDataset.static AdfDataset
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the AdfDataset.static AdfDataset
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the AdfDataset.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) AdfDataset to active.static boolean
Restore the archived (soft-deleted) AdfDataset to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all AdfDataset assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all AdfDataset assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all AdfDataset assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all AdfDataset assets.toString()
Builds the minimal object necessary to create a relationship to a AdfDataset, from a potentially more-complete AdfDataset object.Builds the minimal object necessary to apply an update to a AdfDataset, from a potentially more-complete AdfDataset object.static AdfDataset
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a AdfDataset.static AdfDataset
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a AdfDataset.static AdfDataset
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a AdfDataset.static AdfDataset
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a AdfDataset.static AdfDataset.AdfDatasetBuilder<?,
?> Builds the minimal object necessary to update a AdfDataset.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.IADF
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.IAdfDataset
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.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.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime
-
Field Details
-
TYPE_NAME
- See Also:
-
-
Constructor Details
-
AdfDataset
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a AdfDataset, from a potentially more-complete AdfDataset object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the AdfDataset
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a AdfDataset relationship are not found in the initial object
-
select
Start a fluent search that will return all AdfDataset 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) AdfDataset assets will be included.- Returns:
- a fluent search that includes all AdfDataset assets
-
select
Start a fluent search that will return all AdfDataset 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) AdfDataset assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all AdfDataset assets
-
select
Start a fluent search that will return all AdfDataset 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) AdfDatasets will be included- Returns:
- a fluent search that includes all AdfDataset assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all AdfDataset 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) AdfDatasets will be included- Returns:
- a fluent search that includes all AdfDataset assets
-
refByGuid
Reference to a AdfDataset by GUID. Use this to create a relationship to this AdfDataset, where the relationship should be replaced.- Parameters:
guid
- the GUID of the AdfDataset to reference- Returns:
- reference to a AdfDataset that can be used for defining a relationship to a AdfDataset
-
refByGuid
Reference to a AdfDataset by GUID. Use this to create a relationship to this AdfDataset, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the AdfDataset to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a AdfDataset that can be used for defining a relationship to a AdfDataset
-
refByQualifiedName
Reference to a AdfDataset by qualifiedName. Use this to create a relationship to this AdfDataset, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the AdfDataset to reference- Returns:
- reference to a AdfDataset that can be used for defining a relationship to a AdfDataset
-
refByQualifiedName
Reference to a AdfDataset by qualifiedName. Use this to create a relationship to this AdfDataset, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the AdfDataset to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a AdfDataset that can be used for defining a relationship to a AdfDataset
-
get
Retrieves a AdfDataset by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the AdfDataset to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full AdfDataset, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the AdfDataset does not exist or the provided GUID is not a AdfDataset
-
get
Retrieves a AdfDataset 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 AdfDataset to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full AdfDataset, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the AdfDataset does not exist or the provided GUID is not a AdfDataset
-
get
public static AdfDataset get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a AdfDataset 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 AdfDataset 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 AdfDataset, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the AdfDataset does not exist or the provided GUID is not a AdfDataset
-
restore
Restore the archived (soft-deleted) AdfDataset to active.- Parameters:
qualifiedName
- for the AdfDataset- Returns:
- true if the AdfDataset is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) AdfDataset to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the AdfDataset- Returns:
- true if the AdfDataset is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
updater
Builds the minimal object necessary to update a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the minimal request necessary to update the AdfDataset, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a AdfDataset, from a potentially more-complete AdfDataset object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the AdfDataset, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for AdfDataset are not found in the initial object
-
removeDescription
Remove the system description from a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static AdfDataset removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static AdfDataset removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static AdfDataset removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static AdfDataset removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the AdfDataset's ownersqualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static AdfDataset updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated AdfDataset, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static AdfDataset updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to update the AdfDataset's certificatequalifiedName
- of the AdfDatasetcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated AdfDataset, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
Remove the certificate from a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static AdfDataset removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the AdfDataset's certificatequalifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static AdfDataset updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasettype
- 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 AdfDataset updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to update the AdfDataset's announcementqualifiedName
- of the AdfDatasettype
- 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 AdfDataset removeAnnouncement(String qualifiedName, String name) throws AtlanException Remove the announcement from a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static AdfDataset removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a AdfDataset.- Parameters:
client
- connectivity to the Atlan client from which to remove the AdfDataset's announcementqualifiedName
- of the AdfDatasetname
- of the AdfDataset- Returns:
- the updated AdfDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static AdfDataset replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the AdfDataset.- Parameters:
qualifiedName
- for the AdfDatasetname
- human-readable name of the AdfDatasetterms
- the list of terms to replace on the AdfDataset, or null to remove all terms from the AdfDataset- Returns:
- the AdfDataset that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static AdfDataset replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the AdfDataset's assigned termsqualifiedName
- for the AdfDatasetname
- human-readable name of the AdfDatasetterms
- the list of terms to replace on the AdfDataset, or null to remove all terms from the AdfDataset- Returns:
- the AdfDataset that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static AdfDataset appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the AdfDataset, without replacing existing terms linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the AdfDatasetterms
- the list of terms to append to the AdfDataset- Returns:
- the AdfDataset that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static AdfDataset appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the AdfDataset, without replacing existing terms linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset'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 AdfDatasetqualifiedName
- for the AdfDatasetterms
- the list of terms to append to the AdfDataset- Returns:
- the AdfDataset that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static AdfDataset removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a AdfDataset, without replacing all existing terms linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the AdfDatasetterms
- the list of terms to remove from the AdfDataset, which must be referenced by GUID- Returns:
- the AdfDataset that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static AdfDataset removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a AdfDataset, without replacing all existing terms linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset'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 AdfDatasetqualifiedName
- for the AdfDatasetterms
- the list of terms to remove from the AdfDataset, which must be referenced by GUID- Returns:
- the AdfDataset that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static AdfDataset appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the AdfDatasetatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated AdfDataset
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static AdfDataset appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset'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 AdfDatasetqualifiedName
- of the AdfDatasetatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated AdfDataset
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static AdfDataset appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the AdfDatasetatlanTagNames
- 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 AdfDataset
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static AdfDataset appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a AdfDataset, without replacing existing Atlan tags linked to the AdfDataset. Note: this operation must make two API calls — one to retrieve the AdfDataset'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 AdfDatasetqualifiedName
- of the AdfDatasetatlanTagNames
- 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 AdfDataset
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a AdfDataset.- Parameters:
qualifiedName
- of the AdfDatasetatlanTagName
- 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 AdfDataset
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a AdfDataset.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a AdfDatasetqualifiedName
- of the AdfDatasetatlanTagName
- 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 AdfDataset
-
_internal
-
toBuilder
-
getAdfActivities
ADF Dataset that is associated with these ADF activities.- Specified by:
getAdfActivities
in interfaceIAdfDataset
-
getAdfAssetFolderPath
Defines the folder path in which this ADF asset exists.- Specified by:
getAdfAssetFolderPath
in interfaceIADF
- Specified by:
getAdfAssetFolderPath
in interfaceIAdfDataset
-
getAdfDataflows
ADF Datasets that are associated with this ADF Dataflows.- Specified by:
getAdfDataflows
in interfaceIAdfDataset
-
getAdfDatasetAnnotations
The list of annotation assigned to a dataset.- Specified by:
getAdfDatasetAnnotations
in interfaceIAdfDataset
-
getAdfDatasetCollectionName
Defines the name collection in the cosmos dataset.- Specified by:
getAdfDatasetCollectionName
in interfaceIAdfDataset
-
getAdfDatasetContainerName
Defines the container or bucket name in the storage file system dataset.- Specified by:
getAdfDatasetContainerName
in interfaceIAdfDataset
-
getAdfDatasetDatabaseName
Defines the name of the database used in the azure delta lake type of dataset.- Specified by:
getAdfDatasetDatabaseName
in interfaceIAdfDataset
-
getAdfDatasetFileFolderPath
Defines the folder path of the file in the storage file system dataset.- Specified by:
getAdfDatasetFileFolderPath
in interfaceIAdfDataset
-
getAdfDatasetFileName
Defines the name of the file in the storage file system dataset.- Specified by:
getAdfDatasetFileName
in interfaceIAdfDataset
-
getAdfDatasetLinkedService
Defines the name of the linked service used to create this dataset.- Specified by:
getAdfDatasetLinkedService
in interfaceIAdfDataset
-
getAdfDatasetSchemaName
Defines the name of the schema used in the snowflake, mssql, azure sql database type of dataset.- Specified by:
getAdfDatasetSchemaName
in interfaceIAdfDataset
-
getAdfDatasetStorageType
Defines the storage type of storage file system dataset.- Specified by:
getAdfDatasetStorageType
in interfaceIAdfDataset
-
getAdfDatasetTableName
Defines the name of the table used in the snowflake, mssql, azure sql database type of dataset.- Specified by:
getAdfDatasetTableName
in interfaceIAdfDataset
-
getAdfDatasetType
Defines the type of the dataset.- Specified by:
getAdfDatasetType
in interfaceIAdfDataset
-
getAdfFactoryName
Defines the name of the factory in which this asset exists.- Specified by:
getAdfFactoryName
in interfaceIADF
- Specified by:
getAdfFactoryName
in interfaceIAdfDataset
-
getAdfLinkedservice
ADF datasets that are associated with this ADF Linkedservice.- Specified by:
getAdfLinkedservice
in interfaceIAdfDataset
-
getAdfPipelines
ADF Datasets that are associated with this ADF pipelines.- Specified by:
getAdfPipelines
in interfaceIAdfDataset
-
getApplicationContainer
ApplicationContainer asset containing this Catalog asset.- Specified by:
getApplicationContainer
in interfaceIADF
- Specified by:
getApplicationContainer
in interfaceIAdfDataset
- Specified by:
getApplicationContainer
in interfaceICatalog
-
getAssetApplicationQualifiedName
Qualified name of the Application Container that contains this asset.- Specified by:
getAssetApplicationQualifiedName
in interfaceIADF
- Specified by:
getAssetApplicationQualifiedName
in interfaceIAdfDataset
- Specified by:
getAssetApplicationQualifiedName
in interfaceICatalog
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasks
in interfaceIADF
- Specified by:
getInputToAirflowTasks
in interfaceIAdfDataset
- Specified by:
getInputToAirflowTasks
in interfaceICatalog
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcesses
in interfaceIADF
- Specified by:
getInputToProcesses
in interfaceIAdfDataset
- Specified by:
getInputToProcesses
in interfaceICatalog
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobs
in interfaceIADF
- Specified by:
getInputToSparkJobs
in interfaceIAdfDataset
- Specified by:
getInputToSparkJobs
in interfaceICatalog
-
getModelImplementedEntities
Entities implemented by this asset.- Specified by:
getModelImplementedEntities
in interfaceIADF
- Specified by:
getModelImplementedEntities
in interfaceIAdfDataset
- Specified by:
getModelImplementedEntities
in interfaceICatalog
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasks
in interfaceIADF
- Specified by:
getOutputFromAirflowTasks
in interfaceIAdfDataset
- Specified by:
getOutputFromAirflowTasks
in interfaceICatalog
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcesses
in interfaceIADF
- Specified by:
getOutputFromProcesses
in interfaceIAdfDataset
- Specified by:
getOutputFromProcesses
in interfaceICatalog
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobs
in interfaceIADF
- Specified by:
getOutputFromSparkJobs
in interfaceIAdfDataset
- Specified by:
getOutputFromSparkJobs
in interfaceICatalog
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for AdfDatasets.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIADF
- Specified by:
getTypeName
in interfaceIAdfDataset
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceICatalog
- Specified by:
getTypeName
in interfaceIReferenceable
- Overrides:
getTypeName
in classReference
-