Core Base Classes¶
Asset¶
pyatlan.model.assets.core.asset.Asset(__pydantic_self__, **data: Any)
¶
Bases: Referenceable
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ADMIN_GROUPS: KeywordField = KeywordField('adminGroups', 'adminGroups')
class-attribute
¶
List of groups who administer this asset. (This is only used for certain asset types.)
ADMIN_ROLES: KeywordField = KeywordField('adminRoles', 'adminRoles')
class-attribute
¶
List of roles who administer this asset. (This is only used for Connection assets.)
ADMIN_USERS: KeywordField = KeywordField('adminUsers', 'adminUsers')
class-attribute
¶
List of users who administer this asset. (This is only used for certain asset types.)
ANNOUNCEMENT_MESSAGE: TextField = TextField('announcementMessage', 'announcementMessage')
class-attribute
¶
Detailed message to include in the announcement on this asset.
ANNOUNCEMENT_TITLE: TextField = TextField('announcementTitle', 'announcementTitle')
class-attribute
¶
Brief title for the announcement on this asset. Required when announcementType is specified.
ANNOUNCEMENT_TYPE: KeywordField = KeywordField('announcementType', 'announcementType')
class-attribute
¶
Type of announcement on this asset.
ANNOUNCEMENT_UPDATED_AT: NumericField = NumericField('announcementUpdatedAt', 'announcementUpdatedAt')
class-attribute
¶
Time (epoch) at which the announcement was last updated, in milliseconds.
ANNOUNCEMENT_UPDATED_BY: KeywordField = KeywordField('announcementUpdatedBy', 'announcementUpdatedBy')
class-attribute
¶
Name of the user who last updated the announcement.
ANOMALO_CHECKS: RelationField = RelationField('anomaloChecks')
class-attribute
¶
TBC
APPLICATION: RelationField = RelationField('application')
class-attribute
¶
TBC
APPLICATION_FIELD: RelationField = RelationField('applicationField')
class-attribute
¶
TBC
APPLICATION_FIELD_QUALIFIED_NAME: KeywordField = KeywordField('applicationFieldQualifiedName', 'applicationFieldQualifiedName')
class-attribute
¶
Qualified name of the ApplicationField that contains this asset.
APPLICATION_QUALIFIED_NAME: KeywordField = KeywordField('applicationQualifiedName', 'applicationQualifiedName')
class-attribute
¶
Qualified name of the Application that contains this asset.
ASSET_AI_GENERATED_DESCRIPTION: TextField = TextField('assetAiGeneratedDescription', 'assetAiGeneratedDescription')
class-attribute
¶
Description of this asset, generated by AI based on the asset's context. Displayed separately in the UI and can be used to overwrite existing descriptions.
ASSET_AI_GENERATED_DESCRIPTION_CONFIDENCE: NumericField = NumericField('assetAiGeneratedDescriptionConfidence', 'assetAiGeneratedDescriptionConfidence')
class-attribute
¶
Confidence score of the AI-generated description, ranging from 0.0 to 1.0.
ASSET_AI_GENERATED_DESCRIPTION_REASONING: KeywordField = KeywordField('assetAiGeneratedDescriptionReasoning', 'assetAiGeneratedDescriptionReasoning')
class-attribute
¶
Reasoning behind the AI-generated description, explaining how the description was derived from the asset's context.
ASSET_ANOMALO_APPLIED_CHECK_TYPES: KeywordField = KeywordField('assetAnomaloAppliedCheckTypes', 'assetAnomaloAppliedCheckTypes')
class-attribute
¶
All associated Anomalo check types.
ASSET_ANOMALO_CHECK_COUNT: NumericField = NumericField('assetAnomaloCheckCount', 'assetAnomaloCheckCount')
class-attribute
¶
Total number of checks present in Anomalo for this asset.
ASSET_ANOMALO_CHECK_STATUSES: TextField = TextField('assetAnomaloCheckStatuses', 'assetAnomaloCheckStatuses')
class-attribute
¶
Stringified JSON object containing status of all Anomalo checks associated to this asset.
ASSET_ANOMALO_DQ_STATUS: KeywordField = KeywordField('assetAnomaloDQStatus', 'assetAnomaloDQStatus')
class-attribute
¶
Status of data quality from Anomalo.
ASSET_ANOMALO_FAILED_CHECK_COUNT: NumericField = NumericField('assetAnomaloFailedCheckCount', 'assetAnomaloFailedCheckCount')
class-attribute
¶
Total number of checks failed in Anomalo for this asset.
ASSET_ANOMALO_FAILED_CHECK_TYPES: KeywordField = KeywordField('assetAnomaloFailedCheckTypes', 'assetAnomaloFailedCheckTypes')
class-attribute
¶
All associated Anomalo failed check types.
ASSET_ANOMALO_LAST_CHECK_RUN_AT: NumericField = NumericField('assetAnomaloLastCheckRunAt', 'assetAnomaloLastCheckRunAt')
class-attribute
¶
Time (epoch) at which the last check was run via Anomalo.
ASSET_ANOMALO_SOURCE_URL: TextField = TextField('assetAnomaloSourceUrl', 'assetAnomaloSourceUrl')
class-attribute
¶
URL of the source in Anomalo.
ASSET_COVER_IMAGE: TextField = TextField('assetCoverImage', 'assetCoverImage')
class-attribute
¶
Cover image to use for this asset in the UI (applicable to only a few asset types).
ASSET_DBT_ACCOUNT_NAME: KeywordTextField = KeywordTextField('assetDbtAccountName', 'assetDbtAccountName.keyword', 'assetDbtAccountName')
class-attribute
¶
Name of the account in which this asset exists in dbt.
ASSET_DBT_ALIAS: KeywordTextField = KeywordTextField('assetDbtAlias', 'assetDbtAlias.keyword', 'assetDbtAlias')
class-attribute
¶
Alias of this asset in dbt.
ASSET_DBT_ENVIRONMENT_DBT_VERSION: KeywordField = KeywordField('assetDbtEnvironmentDbtVersion', 'assetDbtEnvironmentDbtVersion')
class-attribute
¶
Version of the environment in which this asset is materialized in dbt.
ASSET_DBT_ENVIRONMENT_NAME: KeywordTextField = KeywordTextField('assetDbtEnvironmentName', 'assetDbtEnvironmentName.keyword', 'assetDbtEnvironmentName')
class-attribute
¶
Name of the environment in which this asset is materialized in dbt.
ASSET_DBT_JOB_LAST_RUN: NumericField = NumericField('assetDbtJobLastRun', 'assetDbtJobLastRun')
class-attribute
¶
Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.
ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED: BooleanField = BooleanField('assetDbtJobLastRunArtifactsSaved', 'assetDbtJobLastRunArtifactsSaved')
class-attribute
¶
Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).
ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH: KeywordField = KeywordField('assetDbtJobLastRunArtifactS3Path', 'assetDbtJobLastRunArtifactS3Path')
class-attribute
¶
Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_CREATED_AT: NumericField = NumericField('assetDbtJobLastRunCreatedAt', 'assetDbtJobLastRunCreatedAt')
class-attribute
¶
Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.
ASSET_DBT_JOB_LAST_RUN_DEQUED_AT: NumericField = NumericField('assetDbtJobLastRunDequedAt', 'assetDbtJobLastRunDequedAt')
class-attribute
¶
Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.
ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID: KeywordField = KeywordField('assetDbtJobLastRunExecutedByThreadId', 'assetDbtJobLastRunExecutedByThreadId')
class-attribute
¶
Thread ID of the user who executed the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH: KeywordTextField = KeywordTextField('assetDbtJobLastRunGitBranch', 'assetDbtJobLastRunGitBranch', 'assetDbtJobLastRunGitBranch.text')
class-attribute
¶
Branch in git from which the last run of the job that materialized this asset in dbt ran.
ASSET_DBT_JOB_LAST_RUN_GIT_SHA: KeywordField = KeywordField('assetDbtJobLastRunGitSha', 'assetDbtJobLastRunGitSha')
class-attribute
¶
SHA hash in git for the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED: BooleanField = BooleanField('assetDbtJobLastRunHasDocsGenerated', 'assetDbtJobLastRunHasDocsGenerated')
class-attribute
¶
Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED: BooleanField = BooleanField('assetDbtJobLastRunHasSourcesGenerated', 'assetDbtJobLastRunHasSourcesGenerated')
class-attribute
¶
Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT: BooleanField = BooleanField('assetDbtJobLastRunNotificationsSent', 'assetDbtJobLastRunNotificationsSent')
class-attribute
¶
Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).
ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID: KeywordField = KeywordField('assetDbtJobLastRunOwnerThreadId', 'assetDbtJobLastRunOwnerThreadId')
class-attribute
¶
Thread ID of the owner of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION: KeywordField = KeywordField('assetDbtJobLastRunQueuedDuration', 'assetDbtJobLastRunQueuedDuration')
class-attribute
¶
Total duration the job that materialized this asset in dbt spent being queued.
ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED: KeywordField = KeywordField('assetDbtJobLastRunQueuedDurationHumanized', 'assetDbtJobLastRunQueuedDurationHumanized')
class-attribute
¶
Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.
ASSET_DBT_JOB_LAST_RUN_RUN_DURATION: KeywordField = KeywordField('assetDbtJobLastRunRunDuration', 'assetDbtJobLastRunRunDuration')
class-attribute
¶
Run duration of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED: KeywordField = KeywordField('assetDbtJobLastRunRunDurationHumanized', 'assetDbtJobLastRunRunDurationHumanized')
class-attribute
¶
Human-readable run duration of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_STARTED_AT: NumericField = NumericField('assetDbtJobLastRunStartedAt', 'assetDbtJobLastRunStartedAt')
class-attribute
¶
Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.
ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE: KeywordTextField = KeywordTextField('assetDbtJobLastRunStatusMessage', 'assetDbtJobLastRunStatusMessage.keyword', 'assetDbtJobLastRunStatusMessage')
class-attribute
¶
Status message of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION: KeywordField = KeywordField('assetDbtJobLastRunTotalDuration', 'assetDbtJobLastRunTotalDuration')
class-attribute
¶
Total duration of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED: TextField = TextField('assetDbtJobLastRunTotalDurationHumanized', 'assetDbtJobLastRunTotalDurationHumanized')
class-attribute
¶
Human-readable total duration of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_LAST_RUN_UPDATED_AT: NumericField = NumericField('assetDbtJobLastRunUpdatedAt', 'assetDbtJobLastRunUpdatedAt')
class-attribute
¶
Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.
ASSET_DBT_JOB_LAST_RUN_URL: KeywordField = KeywordField('assetDbtJobLastRunUrl', 'assetDbtJobLastRunUrl')
class-attribute
¶
URL of the last run of the job that materialized this asset in dbt.
ASSET_DBT_JOB_NAME: KeywordTextField = KeywordTextField('assetDbtJobName', 'assetDbtJobName.keyword', 'assetDbtJobName')
class-attribute
¶
Name of the job that materialized this asset in dbt.
ASSET_DBT_JOB_NEXT_RUN: NumericField = NumericField('assetDbtJobNextRun', 'assetDbtJobNextRun')
class-attribute
¶
Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.
ASSET_DBT_JOB_NEXT_RUN_HUMANIZED: KeywordTextField = KeywordTextField('assetDbtJobNextRunHumanized', 'assetDbtJobNextRunHumanized.keyword', 'assetDbtJobNextRunHumanized')
class-attribute
¶
Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.
ASSET_DBT_JOB_SCHEDULE: KeywordField = KeywordField('assetDbtJobSchedule', 'assetDbtJobSchedule')
class-attribute
¶
Schedule of the job that materialized this asset in dbt.
ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED: TextField = TextField('assetDbtJobScheduleCronHumanized', 'assetDbtJobScheduleCronHumanized')
class-attribute
¶
Human-readable cron schedule of the job that materialized this asset in dbt.
ASSET_DBT_JOB_STATUS: KeywordField = KeywordField('assetDbtJobStatus', 'assetDbtJobStatus')
class-attribute
¶
Status of the job that materialized this asset in dbt.
ASSET_DBT_META: TextField = TextField('assetDbtMeta', 'assetDbtMeta')
class-attribute
¶
Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.
ASSET_DBT_PACKAGE_NAME: KeywordTextField = KeywordTextField('assetDbtPackageName', 'assetDbtPackageName.keyword', 'assetDbtPackageName')
class-attribute
¶
Name of the package in which this asset exists in dbt.
ASSET_DBT_PROJECT_NAME: KeywordTextField = KeywordTextField('assetDbtProjectName', 'assetDbtProjectName.keyword', 'assetDbtProjectName')
class-attribute
¶
Name of the project in which this asset exists in dbt.
ASSET_DBT_SEMANTIC_LAYER_PROXY_URL: KeywordField = KeywordField('assetDbtSemanticLayerProxyUrl', 'assetDbtSemanticLayerProxyUrl')
class-attribute
¶
URL of the semantic layer proxy for this asset in dbt.
ASSET_DBT_SOURCE_FRESHNESS_CRITERIA: TextField = TextField('assetDbtSourceFreshnessCriteria', 'assetDbtSourceFreshnessCriteria')
class-attribute
¶
Freshness criteria for the source of this asset in dbt.
ASSET_DBT_TAGS: KeywordTextField = KeywordTextField('assetDbtTags', 'assetDbtTags', 'assetDbtTags.text')
class-attribute
¶
List of tags attached to this asset in dbt.
ASSET_DBT_TEST_STATUS: KeywordField = KeywordField('assetDbtTestStatus', 'assetDbtTestStatus')
class-attribute
¶
All associated dbt test statuses.
ASSET_DBT_UNIQUE_ID: KeywordTextField = KeywordTextField('assetDbtUniqueId', 'assetDbtUniqueId.keyword', 'assetDbtUniqueId')
class-attribute
¶
Unique identifier of this asset in dbt.
ASSET_DBT_WORKFLOW_LAST_UPDATED: KeywordField = KeywordField('assetDbtWorkflowLastUpdated', 'assetDbtWorkflowLastUpdated')
class-attribute
¶
Name of the DBT workflow in Atlan that last updated the asset.
ASSET_DQ_FRESHNESS_EXPECTATION: NumericField = NumericField('assetDQFreshnessExpectation', 'assetDQFreshnessExpectation')
class-attribute
¶
Expectation of data freshness from Source.
ASSET_DQ_FRESHNESS_VALUE: NumericField = NumericField('assetDQFreshnessValue', 'assetDQFreshnessValue')
class-attribute
¶
Value of data freshness from Source.
ASSET_DQ_MANUAL_RUN_STATUS: KeywordField = KeywordField('assetDQManualRunStatus', 'assetDQManualRunStatus')
class-attribute
¶
Status of the latest manual DQ run triggered for this asset.
ASSET_DQ_RESULT: KeywordField = KeywordField('assetDQResult', 'assetDQResult')
class-attribute
¶
Overall result of all the dq rules. If any one rule failed, then fail else pass.
ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME: KeywordField = KeywordField('assetDQRowScopeFilterColumnQualifiedName', 'assetDQRowScopeFilterColumnQualifiedName')
class-attribute
¶
Qualified name of the column used for row scope filtering in DQ rules for this asset.
ASSET_DQ_RULE_ATTACHED_DIMENSIONS: KeywordField = KeywordField('assetDQRuleAttachedDimensions', 'assetDQRuleAttachedDimensions')
class-attribute
¶
List of all the dimensions of attached rules.
ASSET_DQ_RULE_ATTACHED_RULE_TYPES: KeywordField = KeywordField('assetDQRuleAttachedRuleTypes', 'assetDQRuleAttachedRuleTypes')
class-attribute
¶
List of all the types of attached rules.
ASSET_DQ_RULE_FAILED_COUNT: NumericField = NumericField('assetDQRuleFailedCount', 'assetDQRuleFailedCount')
class-attribute
¶
Count of failed DQ rules attached to this asset.
ASSET_DQ_RULE_FAILED_DIMENSIONS: KeywordField = KeywordField('assetDQRuleFailedDimensions', 'assetDQRuleFailedDimensions')
class-attribute
¶
List of all the dimensions of failed rules.
ASSET_DQ_RULE_FAILED_RULE_TYPES: KeywordField = KeywordField('assetDQRuleFailedRuleTypes', 'assetDQRuleFailedRuleTypes')
class-attribute
¶
List of all the types of failed rules.
ASSET_DQ_RULE_LAST_RUN_AT: NumericField = NumericField('assetDQRuleLastRunAt', 'assetDQRuleLastRunAt')
class-attribute
¶
Time (epoch) at which the last dq rule ran.
ASSET_DQ_RULE_PASSED_COUNT: NumericField = NumericField('assetDQRulePassedCount', 'assetDQRulePassedCount')
class-attribute
¶
Count of passed DQ rules attached to this asset.
ASSET_DQ_RULE_PASSED_DIMENSIONS: KeywordField = KeywordField('assetDQRulePassedDimensions', 'assetDQRulePassedDimensions')
class-attribute
¶
List of all the dimensions for which all the rules passed.
ASSET_DQ_RULE_PASSED_RULE_TYPES: KeywordField = KeywordField('assetDQRulePassedRuleTypes', 'assetDQRulePassedRuleTypes')
class-attribute
¶
List of all the types of rules for which all the rules passed.
ASSET_DQ_RULE_RESULT_TAGS: KeywordField = KeywordField('assetDQRuleResultTags', 'assetDQRuleResultTags')
class-attribute
¶
Tag for the result of the DQ rules. Eg, rule_pass:completeness:null_count.
ASSET_DQ_RULE_TOTAL_COUNT: NumericField = NumericField('assetDQRuleTotalCount', 'assetDQRuleTotalCount')
class-attribute
¶
Count of DQ rules attached to this asset.
ASSET_DQ_SCHEDULE_CRONTAB: KeywordField = KeywordField('assetDQScheduleCrontab', 'assetDQScheduleCrontab')
class-attribute
¶
Crontab of the DQ rule that will run at datasource.
ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT: NumericField = NumericField('assetDQScheduleSourceSyncedAt', 'assetDQScheduleSourceSyncedAt')
class-attribute
¶
Time (epoch) at which the schedule synced to the source.
ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE: KeywordField = KeywordField('assetDQScheduleSourceSyncErrorCode', 'assetDQScheduleSourceSyncErrorCode')
class-attribute
¶
Error code in the case of sync state being "error".
ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE: TextField = TextField('assetDQScheduleSourceSyncErrorMessage', 'assetDQScheduleSourceSyncErrorMessage')
class-attribute
¶
Error message in the case of sync state being "error".
ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR: TextField = TextField('assetDQScheduleSourceSyncRawError', 'assetDQScheduleSourceSyncRawError')
class-attribute
¶
Raw error message from the source.
ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS: KeywordField = KeywordField('assetDQScheduleSourceSyncStatus', 'assetDQScheduleSourceSyncStatus')
class-attribute
¶
Latest sync status of the schedule to the source.
ASSET_DQ_SCHEDULE_TIME_ZONE: KeywordField = KeywordField('assetDQScheduleTimeZone', 'assetDQScheduleTimeZone')
class-attribute
¶
Timezone of the DQ rule schedule that will run at datasource
ASSET_DQ_SCHEDULE_TYPE: KeywordField = KeywordField('assetDQScheduleType', 'assetDQScheduleType')
class-attribute
¶
Type of schedule of the DQ rule that will run at datasource.
ASSET_EXTERNAL_DQ_METADATA_DETAILS: KeywordField = KeywordField('assetExternalDQMetadataDetails', 'assetExternalDQMetadataDetails')
class-attribute
¶
DQ metadata captured for asset from external DQ tool(s).
ASSET_GCP_DATAPLEX_ASPECT_FIELD_LIST: KeywordField = KeywordField('assetGCPDataplexAspectFieldList', 'assetGCPDataplexAspectFieldList')
class-attribute
¶
List of field key-values associated with all Aspects linked to this asset.
ASSET_GCP_DATAPLEX_ASPECT_LIST: KeywordField = KeywordField('assetGCPDataplexAspectList', 'assetGCPDataplexAspectList')
class-attribute
¶
List of names of all Aspects linked to this asset.
ASSET_GCP_DATAPLEX_METADATA_DETAILS: KeywordField = KeywordField('assetGCPDataplexMetadataDetails', 'assetGCPDataplexMetadataDetails')
class-attribute
¶
Metrics captured by GCP Dataplex for objects associated with GCP services.
ASSET_ICON: TextField = TextField('assetIcon', 'assetIcon')
class-attribute
¶
Name of the icon to use for this asset. (Only applies to glossaries, currently.)
ASSET_INTERNAL_POPULARITY_SCORE: NumericRankField = NumericRankField('assetInternalPopularityScore', 'assetInternalPopularityScore', 'assetInternalPopularityScore.rank_feature')
class-attribute
¶
Internal Popularity score for this asset.
ASSET_MC_ALERT_QUALIFIED_NAMES: KeywordTextField = KeywordTextField('assetMcAlertQualifiedNames', 'assetMcAlertQualifiedNames', 'assetMcAlertQualifiedNames.text')
class-attribute
¶
List of unique Monte Carlo alert names attached to this asset.
ASSET_MC_INCIDENT_NAMES: KeywordTextField = KeywordTextField('assetMcIncidentNames', 'assetMcIncidentNames.keyword', 'assetMcIncidentNames')
class-attribute
¶
List of Monte Carlo incident names attached to this asset.
ASSET_MC_INCIDENT_PRIORITIES: KeywordField = KeywordField('assetMcIncidentPriorities', 'assetMcIncidentPriorities')
class-attribute
¶
List of Monte Carlo incident priorities associated with this asset.
ASSET_MC_INCIDENT_QUALIFIED_NAMES: KeywordTextField = KeywordTextField('assetMcIncidentQualifiedNames', 'assetMcIncidentQualifiedNames', 'assetMcIncidentQualifiedNames.text')
class-attribute
¶
List of unique Monte Carlo incident names attached to this asset.
ASSET_MC_INCIDENT_SEVERITIES: KeywordField = KeywordField('assetMcIncidentSeverities', 'assetMcIncidentSeverities')
class-attribute
¶
List of Monte Carlo incident severities associated with this asset.
ASSET_MC_INCIDENT_STATES: KeywordField = KeywordField('assetMcIncidentStates', 'assetMcIncidentStates')
class-attribute
¶
List of Monte Carlo incident states associated with this asset.
ASSET_MC_INCIDENT_SUB_TYPES: KeywordField = KeywordField('assetMcIncidentSubTypes', 'assetMcIncidentSubTypes')
class-attribute
¶
List of Monte Carlo incident sub-types associated with this asset.
ASSET_MC_INCIDENT_TYPES: KeywordField = KeywordField('assetMcIncidentTypes', 'assetMcIncidentTypes')
class-attribute
¶
List of Monte Carlo incident types associated with this asset.
ASSET_MC_IS_MONITORED: BooleanField = BooleanField('assetMcIsMonitored', 'assetMcIsMonitored')
class-attribute
¶
Tracks whether this asset is monitored by MC or not
ASSET_MC_LAST_SYNC_RUN_AT: NumericField = NumericField('assetMcLastSyncRunAt', 'assetMcLastSyncRunAt')
class-attribute
¶
Time (epoch) at which this asset was last synced from Monte Carlo.
ASSET_MC_MONITOR_NAMES: KeywordTextField = KeywordTextField('assetMcMonitorNames', 'assetMcMonitorNames.keyword', 'assetMcMonitorNames')
class-attribute
¶
List of Monte Carlo monitor names attached to this asset.
ASSET_MC_MONITOR_QUALIFIED_NAMES: KeywordTextField = KeywordTextField('assetMcMonitorQualifiedNames', 'assetMcMonitorQualifiedNames', 'assetMcMonitorQualifiedNames.text')
class-attribute
¶
List of unique Monte Carlo monitor names attached to this asset.
ASSET_MC_MONITOR_SCHEDULE_TYPES: KeywordField = KeywordField('assetMcMonitorScheduleTypes', 'assetMcMonitorScheduleTypes')
class-attribute
¶
Schedules of all associated Monte Carlo monitors.
ASSET_MC_MONITOR_STATUSES: KeywordField = KeywordField('assetMcMonitorStatuses', 'assetMcMonitorStatuses')
class-attribute
¶
Statuses of all associated Monte Carlo monitors.
ASSET_MC_MONITOR_TYPES: KeywordField = KeywordField('assetMcMonitorTypes', 'assetMcMonitorTypes')
class-attribute
¶
Types of all associated Monte Carlo monitors.
ASSET_POLICIES_COUNT: NumericField = NumericField('assetPoliciesCount', 'assetPoliciesCount')
class-attribute
¶
Count of policies inside the asset
ASSET_POLICY_GUIDS: KeywordField = KeywordField('assetPolicyGUIDs', 'assetPolicyGUIDs')
class-attribute
¶
Array of policy ids governing this asset
ASSET_REDIRECT_GUIDS: KeywordField = KeywordField('assetRedirectGUIDs', 'assetRedirectGUIDs')
class-attribute
¶
Array of asset ids that equivalent to this asset.
ASSET_SMUS_METADATA_FORM_DETAILS: KeywordField = KeywordField('assetSmusMetadataFormDetails', 'assetSmusMetadataFormDetails')
class-attribute
¶
AWS SMUS Asset MetadataForm details
ASSET_SMUS_METADATA_FORM_KEY_VALUE_DETAILS: KeywordTextField = KeywordTextField('assetSmusMetadataFormKeyValueDetails', 'assetSmusMetadataFormKeyValueDetails.keyword', 'assetSmusMetadataFormKeyValueDetails')
class-attribute
¶
List of AWS SMUS MetadataForm Key:Value Details. This is mainly used for filtering purpose.
ASSET_SMUS_METADATA_FORM_NAMES: KeywordTextField = KeywordTextField('assetSmusMetadataFormNames', 'assetSmusMetadataFormNames.keyword', 'assetSmusMetadataFormNames')
class-attribute
¶
List of AWS SMUS MetadataForm Names. This is mainly used for filtering purpose.
ASSET_SODA_CHECK_COUNT: NumericField = NumericField('assetSodaCheckCount', 'assetSodaCheckCount')
class-attribute
¶
Number of checks done via Soda.
ASSET_SODA_CHECK_STATUSES: TextField = TextField('assetSodaCheckStatuses', 'assetSodaCheckStatuses')
class-attribute
¶
All associated Soda check statuses.
ASSET_SODA_DQ_STATUS: KeywordField = KeywordField('assetSodaDQStatus', 'assetSodaDQStatus')
class-attribute
¶
Status of data quality from Soda.
ASSET_SODA_LAST_SCAN_AT: NumericField = NumericField('assetSodaLastScanAt', 'assetSodaLastScanAt')
class-attribute
¶
ASSET_SODA_LAST_SYNC_RUN_AT: NumericField = NumericField('assetSodaLastSyncRunAt', 'assetSodaLastSyncRunAt')
class-attribute
¶
ASSET_SODA_SOURCE_URL: KeywordField = KeywordField('assetSodaSourceURL', 'assetSodaSourceURL')
class-attribute
¶
ASSET_SOURCE_ID: KeywordField = KeywordField('assetSourceId', 'assetSourceId')
class-attribute
¶
Unique identifier for this asset in the system from which it was sourced.
ASSET_SOURCE_README: KeywordTextField = KeywordTextField('assetSourceReadme', 'assetSourceReadme.keyword', 'assetSourceReadme')
class-attribute
¶
Readme of this asset, as extracted from source. If present, this will be used for the readme in user interface.
ASSET_SPACE_NAME: KeywordField = KeywordField('assetSpaceName', 'assetSpaceName')
class-attribute
¶
Name of the space that contains this asset.
ASSET_SPACE_QUALIFIED_NAME: KeywordField = KeywordField('assetSpaceQualifiedName', 'assetSpaceQualifiedName')
class-attribute
¶
Unique name of the space that contains this asset.
ASSET_TAGS: KeywordTextField = KeywordTextField('assetTags', 'assetTags', 'assetTags.text')
class-attribute
¶
List of tags attached to this asset.
ASSET_THEME_HEX: TextField = TextField('assetThemeHex', 'assetThemeHex')
class-attribute
¶
Color (in hexadecimal RGB) to use to represent this asset.
ASSET_USER_DEFINED_TYPE: KeywordField = KeywordField('assetUserDefinedType', 'assetUserDefinedType')
class-attribute
¶
Name to use for this type of asset, as a subtype of the actual typeName.
CERTIFICATE_STATUS: KeywordTextField = KeywordTextField('certificateStatus', 'certificateStatus', 'certificateStatus.text')
class-attribute
¶
Status of this asset's certification.
CERTIFICATE_STATUS_MESSAGE: TextField = TextField('certificateStatusMessage', 'certificateStatusMessage')
class-attribute
¶
Human-readable descriptive message used to provide further detail to certificateStatus.
CERTIFICATE_UPDATED_AT: NumericField = NumericField('certificateUpdatedAt', 'certificateUpdatedAt')
class-attribute
¶
Time (epoch) at which the certification was last updated, in milliseconds.
CERTIFICATE_UPDATED_BY: KeywordField = KeywordField('certificateUpdatedBy', 'certificateUpdatedBy')
class-attribute
¶
Name of the user who last updated the certification of this asset.
CONNECTION_NAME: KeywordTextField = KeywordTextField('connectionName', 'connectionName', 'connectionName.text')
class-attribute
¶
Simple name of the connection through which this asset is accessible.
CONNECTION_QUALIFIED_NAME: KeywordTextField = KeywordTextField('connectionQualifiedName', 'connectionQualifiedName', 'connectionQualifiedName.text')
class-attribute
¶
Unique name of the connection through which this asset is accessible.
CONNECTOR_NAME: KeywordField = KeywordField('connectorName', 'connectorName')
class-attribute
¶
Type of the connector through which this asset is accessible.
DATA_CONTRACT_LATEST: RelationField = RelationField('dataContractLatest')
class-attribute
¶
TBC
DATA_CONTRACT_LATEST_CERTIFIED: RelationField = RelationField('dataContractLatestCertified')
class-attribute
¶
TBC
DBT_QUALIFIED_NAME: KeywordTextField = KeywordTextField('dbtQualifiedName', 'dbtQualifiedName', 'dbtQualifiedName.text')
class-attribute
¶
Unique name of this asset in dbt.
DESCRIPTION: KeywordTextField = KeywordTextField('description', 'description.keyword', 'description.text')
class-attribute
¶
Description of this asset, for example as crawled from a source. Fallback for display purposes, if userDescription is empty.
DISPLAY_NAME: KeywordTextField = KeywordTextField('displayName', 'displayName.keyword', 'displayName.delimiter')
class-attribute
¶
Human-readable name of this asset used for display purposes (in user interface).
DOMAIN_GUIDS: KeywordField = KeywordField('domainGUIDs', 'domainGUIDs')
class-attribute
¶
Array of domain guids linked to this asset
DQ_BASE_DATASET_RULES: RelationField = RelationField('dqBaseDatasetRules')
class-attribute
¶
TBC
DQ_REFERENCE_DATASET_RULES: RelationField = RelationField('dqReferenceDatasetRules')
class-attribute
¶
TBC
FILES: RelationField = RelationField('files')
class-attribute
¶
TBC
HAS_CONTRACT: BooleanField = BooleanField('hasContract', 'hasContract')
class-attribute
¶
Whether this asset has contract (true) or not (false).
HAS_LINEAGE: BooleanField = BooleanField('__hasLineage', '__hasLineage')
class-attribute
¶
Whether this asset has lineage (true) or not (false).
INPUT_PORT_DATA_PRODUCTS: RelationField = RelationField('inputPortDataProducts')
class-attribute
¶
TBC
IS_AI_GENERATED: BooleanField = BooleanField('isAIGenerated', 'isAIGenerated')
class-attribute
¶
IS_DISCOVERABLE: BooleanField = BooleanField('isDiscoverable', 'isDiscoverable')
class-attribute
¶
Whether this asset is discoverable through the UI (true) or not (false).
IS_EDITABLE: BooleanField = BooleanField('isEditable', 'isEditable')
class-attribute
¶
Whether this asset can be edited in the UI (true) or not (false).
IS_PARTIAL: BooleanField = BooleanField('isPartial', 'isPartial')
class-attribute
¶
Indicates this asset is not fully-known, if true.
LAST_ROW_CHANGED_AT: NumericField = NumericField('lastRowChangedAt', 'lastRowChangedAt')
class-attribute
¶
Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.
LAST_SYNC_RUN: KeywordField = KeywordField('lastSyncRun', 'lastSyncRun')
class-attribute
¶
Name of the last run of the crawler that last synchronized this asset.
LAST_SYNC_RUN_AT: NumericField = NumericField('lastSyncRunAt', 'lastSyncRunAt')
class-attribute
¶
Time (epoch) at which this asset was last crawled, in milliseconds.
LAST_SYNC_WORKFLOW_NAME: KeywordField = KeywordField('lastSyncWorkflowName', 'lastSyncWorkflowName')
class-attribute
¶
Name of the crawler that last synchronized this asset.
LEXICOGRAPHICAL_SORT_ORDER: KeywordField = KeywordField('lexicographicalSortOrder', 'lexicographicalSortOrder')
class-attribute
¶
Custom order for sorting purpose, managed by client
LINKS: RelationField = RelationField('links')
class-attribute
¶
TBC
MC_INCIDENTS: RelationField = RelationField('mcIncidents')
class-attribute
¶
TBC
MC_MONITORS: RelationField = RelationField('mcMonitors')
class-attribute
¶
TBC
METRICS: RelationField = RelationField('metrics')
class-attribute
¶
TBC
NAME: KeywordTextStemmedField = KeywordTextStemmedField('name', 'name.keyword', 'name', 'name.stemmed')
class-attribute
¶
Name of this asset. Fallback for display purposes, if displayName is empty.
NON_COMPLIANT_ASSET_POLICY_GUIDS: KeywordField = KeywordField('nonCompliantAssetPolicyGUIDs', 'nonCompliantAssetPolicyGUIDs')
class-attribute
¶
Array of policy ids non-compliant to this asset
OUTPUT_PORT_DATA_PRODUCTS: RelationField = RelationField('outputPortDataProducts')
class-attribute
¶
TBC
OUTPUT_PRODUCT_GUIDS: KeywordField = KeywordField('outputProductGUIDs', 'outputProductGUIDs')
class-attribute
¶
Array of product guids which have this asset as outputPort
OWNER_GROUPS: KeywordField = KeywordField('ownerGroups', 'ownerGroups')
class-attribute
¶
List of groups who own this asset.
OWNER_USERS: KeywordField = KeywordField('ownerUsers', 'ownerUsers')
class-attribute
¶
List of users who own this asset.
POPULARITY_SCORE: NumericRankField = NumericRankField('popularityScore', 'popularityScore', 'popularityScore.rank_feature')
class-attribute
¶
Popularity score for this asset.
PRODUCT_GUIDS: KeywordField = KeywordField('productGUIDs', 'productGUIDs')
class-attribute
¶
Array of product guids linked to this asset
README: RelationField = RelationField('readme')
class-attribute
¶
TBC
SAMPLE_DATA_URL: KeywordTextField = KeywordTextField('sampleDataUrl', 'sampleDataUrl', 'sampleDataUrl.text')
class-attribute
¶
URL for sample data for this asset.
SCHEMA_REGISTRY_SUBJECTS: RelationField = RelationField('schemaRegistrySubjects')
class-attribute
¶
TBC
SODA_CHECKS: RelationField = RelationField('sodaChecks')
class-attribute
¶
TBC
SOURCE_COST_UNIT: KeywordField = KeywordField('sourceCostUnit', 'sourceCostUnit')
class-attribute
¶
The unit of measure for sourceTotalCost.
SOURCE_CREATED_AT: NumericField = NumericField('sourceCreatedAt', 'sourceCreatedAt')
class-attribute
¶
Time (epoch) at which this asset was created in the source system, in milliseconds.
SOURCE_CREATED_BY: KeywordField = KeywordField('sourceCreatedBy', 'sourceCreatedBy')
class-attribute
¶
Name of the user who created this asset, in the source system.
SOURCE_EMBED_URL: KeywordField = KeywordField('sourceEmbedURL', 'sourceEmbedURL')
class-attribute
¶
URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.
SOURCE_LAST_READ_AT: NumericField = NumericField('sourceLastReadAt', 'sourceLastReadAt')
class-attribute
¶
Timestamp of most recent read operation.
SOURCE_OWNERS: TextField = TextField('sourceOwners', 'sourceOwners')
class-attribute
¶
List of owners of this asset, in the source system.
SOURCE_QUERY_COMPUTE_COST_LIST: KeywordField = KeywordField('sourceQueryComputeCostList', 'sourceQueryComputeCostList')
class-attribute
¶
List of most expensive warehouse names.
SOURCE_QUERY_COMPUTE_COST_RECORD_LIST: KeywordField = KeywordField('sourceQueryComputeCostRecordList', 'sourceQueryComputeCostRecordList')
class-attribute
¶
List of most expensive warehouses with extra insights.
SOURCE_READ_COUNT: NumericField = NumericField('sourceReadCount', 'sourceReadCount')
class-attribute
¶
Total count of all read operations at source.
SOURCE_READ_EXPENSIVE_QUERY_RECORD_LIST: KeywordField = KeywordField('sourceReadExpensiveQueryRecordList', 'sourceReadExpensiveQueryRecordList')
class-attribute
¶
List of the most expensive queries that accessed this asset.
SOURCE_READ_POPULAR_QUERY_RECORD_LIST: KeywordField = KeywordField('sourceReadPopularQueryRecordList', 'sourceReadPopularQueryRecordList')
class-attribute
¶
List of the most popular queries that accessed this asset.
SOURCE_READ_QUERY_COST: NumericField = NumericField('sourceReadQueryCost', 'sourceReadQueryCost')
class-attribute
¶
Total cost of read queries at source.
SOURCE_READ_RECENT_USER_LIST: KeywordField = KeywordField('sourceReadRecentUserList', 'sourceReadRecentUserList')
class-attribute
¶
List of usernames of the most recent users who read this asset.
SOURCE_READ_RECENT_USER_RECORD_LIST: KeywordField = KeywordField('sourceReadRecentUserRecordList', 'sourceReadRecentUserRecordList')
class-attribute
¶
List of usernames with extra insights for the most recent users who read this asset.
SOURCE_READ_SLOW_QUERY_RECORD_LIST: KeywordField = KeywordField('sourceReadSlowQueryRecordList', 'sourceReadSlowQueryRecordList')
class-attribute
¶
List of the slowest queries that accessed this asset.
SOURCE_READ_TOP_USER_LIST: KeywordField = KeywordField('sourceReadTopUserList', 'sourceReadTopUserList')
class-attribute
¶
List of usernames of the users who read this asset the most.
SOURCE_READ_TOP_USER_RECORD_LIST: KeywordField = KeywordField('sourceReadTopUserRecordList', 'sourceReadTopUserRecordList')
class-attribute
¶
List of usernames with extra insights for the users who read this asset the most.
SOURCE_READ_USER_COUNT: NumericField = NumericField('sourceReadUserCount', 'sourceReadUserCount')
class-attribute
¶
Total number of unique users that read data from asset.
SOURCE_TOTAL_COST: NumericField = NumericField('sourceTotalCost', 'sourceTotalCost')
class-attribute
¶
Total cost of all operations at source.
SOURCE_UPDATED_AT: NumericField = NumericField('sourceUpdatedAt', 'sourceUpdatedAt')
class-attribute
¶
Time (epoch) at which this asset was last updated in the source system, in milliseconds.
SOURCE_UPDATED_BY: KeywordField = KeywordField('sourceUpdatedBy', 'sourceUpdatedBy')
class-attribute
¶
Name of the user who last updated this asset, in the source system.
SOURCE_URL: KeywordField = KeywordField('sourceURL', 'sourceURL')
class-attribute
¶
URL to the resource within the source application, used to create a button to view this asset in the source application.
STARRED_BY: KeywordField = KeywordField('starredBy', 'starredBy')
class-attribute
¶
Users who have starred this asset.
STARRED_COUNT: NumericField = NumericField('starredCount', 'starredCount')
class-attribute
¶
Number of users who have starred this asset.
STARRED_DETAILS_LIST: KeywordField = KeywordField('starredDetailsList', 'starredDetailsList')
class-attribute
¶
List of usernames with extra information of the users who have starred an asset.
SUB_TYPE: KeywordField = KeywordField('subType', 'subType')
class-attribute
¶
Subtype of this asset.
TENANT_ID: TextField = TextField('tenantId', 'tenantId')
class-attribute
¶
Name of the Atlan workspace in which this asset exists.
USER_DEF_RELATIONSHIP_FROM: RelationField = RelationField('userDefRelationshipFrom')
class-attribute
¶
TBC
USER_DEF_RELATIONSHIP_TO: RelationField = RelationField('userDefRelationshipTo')
class-attribute
¶
TBC
USER_DESCRIPTION: KeywordTextField = KeywordTextField('userDescription', 'userDescription.keyword', 'userDescription.text')
class-attribute
¶
Description of this asset, as provided by a user. If present, this will be used for the description in user interface.
VIEWER_GROUPS: KeywordField = KeywordField('viewerGroups', 'viewerGroups')
class-attribute
¶
List of groups who can view assets contained in a collection. (This is only used for certain asset types.)
VIEWER_USERS: KeywordField = KeywordField('viewerUsers', 'viewerUsers')
class-attribute
¶
List of users who can view assets contained in a collection. (This is only used for certain asset types.)
VIEW_SCORE: NumericRankField = NumericRankField('viewScore', 'viewScore', 'viewScore.rank_feature')
class-attribute
¶
View score for this asset.
Classes¶
Functions¶
lineage(guid: str, include_archived: bool = False) -> 'FluentLineage'
classmethod
¶
Start a FluentLineage that can be used to get a LineageListRequest that can be used to retrieve all downstream assets. Additional conditions can be chained onto the returned FluentLineage before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. (To change the default direction of downstream chain a .direction() call
:param guid: unique identifier (GUID) for the starting point of lineage :param include_archived: when True, archived (soft-deleted) assets in lineage will be included :returns: a FluentLineage that can be used to get a LineageListRequest that can be used to retrieve all downstream assets
Source code in pyatlan/model/assets/core/asset.py
BIProcess¶
pyatlan.model.assets.core.b_i_process.BIProcess(__pydantic_self__, **data: Any)
¶
Catalog¶
pyatlan.model.assets.core.catalog.Catalog(__pydantic_self__, **data: Any)
¶
Bases: Asset
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
INPUT_TO_AIRFLOW_TASKS: RelationField = RelationField('inputToAirflowTasks')
class-attribute
¶
TBC
INPUT_TO_PROCESSES: RelationField = RelationField('inputToProcesses')
class-attribute
¶
TBC
INPUT_TO_SPARK_JOBS: RelationField = RelationField('inputToSparkJobs')
class-attribute
¶
TBC
MODEL_IMPLEMENTED_ATTRIBUTES: RelationField = RelationField('modelImplementedAttributes')
class-attribute
¶
TBC
MODEL_IMPLEMENTED_ENTITIES: RelationField = RelationField('modelImplementedEntities')
class-attribute
¶
TBC
OUTPUT_FROM_AIRFLOW_TASKS: RelationField = RelationField('outputFromAirflowTasks')
class-attribute
¶
TBC
OUTPUT_FROM_PROCESSES: RelationField = RelationField('outputFromProcesses')
class-attribute
¶
TBC
OUTPUT_FROM_SPARK_JOBS: RelationField = RelationField('outputFromSparkJobs')
class-attribute
¶
TBC
PARTIAL_CHILD_FIELDS: RelationField = RelationField('partialChildFields')
class-attribute
¶
TBC
PARTIAL_CHILD_OBJECTS: RelationField = RelationField('partialChildObjects')
class-attribute
¶
TBC
ColumnProcess¶
pyatlan.model.assets.core.column_process.ColumnProcess(__pydantic_self__, **data: Any)
¶
Bases: Process
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
INPUTS: RelationField = RelationField('inputs')
class-attribute
¶
Assets that are inputs to this process.
OUTPUTS: RelationField = RelationField('outputs')
class-attribute
¶
Assets that are outputs from this process.
PROCESS: RelationField = RelationField('process')
class-attribute
¶
TBC
Flow¶
pyatlan.model.assets.core.flow.Flow(__pydantic_self__, **data: Any)
¶
Bases: Asset
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
FLOW_ERROR_MESSAGE: KeywordField = KeywordField('flowErrorMessage', 'flowErrorMessage')
class-attribute
¶
Optional error message of the flow run.
FLOW_FINISHED_AT: NumericField = NumericField('flowFinishedAt', 'flowFinishedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration finished.
FLOW_FOLDER_NAME: KeywordTextField = KeywordTextField('flowFolderName', 'flowFolderName.keyword', 'flowFolderName')
class-attribute
¶
Simple name of the folder in which this asset is contained.
FLOW_FOLDER_QUALIFIED_NAME: KeywordField = KeywordField('flowFolderQualifiedName', 'flowFolderQualifiedName')
class-attribute
¶
Unique name of the folder in which this asset is contained.
FLOW_ID: KeywordField = KeywordField('flowId', 'flowId')
class-attribute
¶
Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.
FLOW_INPUT_PARAMETERS: KeywordField = KeywordField('flowInputParameters', 'flowInputParameters')
class-attribute
¶
Input parameters for the flow run.
FLOW_PROJECT_NAME: KeywordTextField = KeywordTextField('flowProjectName', 'flowProjectName.keyword', 'flowProjectName')
class-attribute
¶
Simple name of the project in which this asset is contained.
FLOW_PROJECT_QUALIFIED_NAME: KeywordField = KeywordField('flowProjectQualifiedName', 'flowProjectQualifiedName')
class-attribute
¶
Unique name of the project in which this asset is contained.
FLOW_REUSABLE_UNIT_NAME: KeywordTextField = KeywordTextField('flowReusableUnitName', 'flowReusableUnitName.keyword', 'flowReusableUnitName')
class-attribute
¶
Simple name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_REUSABLE_UNIT_QUALIFIED_NAME: KeywordField = KeywordField('flowReusableUnitQualifiedName', 'flowReusableUnitQualifiedName')
class-attribute
¶
Unique name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_RUN_ID: KeywordField = KeywordField('flowRunId', 'flowRunId')
class-attribute
¶
Unique ID of the flow run, which could change on subsequent runs of the same flow.
FLOW_SCHEDULE: KeywordField = KeywordField('flowSchedule', 'flowSchedule')
class-attribute
¶
Schedule for this point in the data processing or orchestration.
FLOW_STARTED_AT: NumericField = NumericField('flowStartedAt', 'flowStartedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration started.
FLOW_STATUS: KeywordField = KeywordField('flowStatus', 'flowStatus')
class-attribute
¶
Overall status of this point in the data processing or orchestration.
FlowControlOperation¶
pyatlan.model.assets.core.flow_control_operation.FlowControlOperation(__pydantic_self__, **data: Any)
¶
Bases: Flow
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
FLOW_CONTROLLED_BY: RelationField = RelationField('flowControlledBy')
class-attribute
¶
TBC
FLOW_CONTROLLED_OPERATIONS: RelationField = RelationField('flowControlledOperations')
class-attribute
¶
TBC
FLOW_DATA_RESULTS: RelationField = RelationField('flowDataResults')
class-attribute
¶
TBC
FLOW_PREDECESSORS: RelationField = RelationField('flowPredecessors')
class-attribute
¶
TBC
FLOW_SUCCESSORS: RelationField = RelationField('flowSuccessors')
class-attribute
¶
TBC
FlowDataset¶
pyatlan.model.assets.core.flow_dataset.FlowDataset(__pydantic_self__, **data: Any)
¶
Bases: Catalog
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
FLOW_DETAILED_BY: RelationField = RelationField('flowDetailedBy')
class-attribute
¶
TBC
FLOW_ERROR_MESSAGE: KeywordField = KeywordField('flowErrorMessage', 'flowErrorMessage')
class-attribute
¶
Optional error message of the flow run.
FLOW_EXPRESSION: KeywordField = KeywordField('flowExpression', 'flowExpression')
class-attribute
¶
Logic that is applied, injected or otherwise used as part of producing this ephemeral piece of data.
FLOW_FIELDS: RelationField = RelationField('flowFields')
class-attribute
¶
TBC
FLOW_FIELD_COUNT: NumericField = NumericField('flowFieldCount', 'flowFieldCount')
class-attribute
¶
Count of the number of individual fields that make up this ephemeral dataset.
FLOW_FINISHED_AT: NumericField = NumericField('flowFinishedAt', 'flowFinishedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration finished.
FLOW_FOLDER_NAME: KeywordTextField = KeywordTextField('flowFolderName', 'flowFolderName.keyword', 'flowFolderName')
class-attribute
¶
Simple name of the folder in which this asset is contained.
FLOW_FOLDER_QUALIFIED_NAME: KeywordField = KeywordField('flowFolderQualifiedName', 'flowFolderQualifiedName')
class-attribute
¶
Unique name of the folder in which this asset is contained.
FLOW_ID: KeywordField = KeywordField('flowId', 'flowId')
class-attribute
¶
Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.
FLOW_INPUT_PARAMETERS: KeywordField = KeywordField('flowInputParameters', 'flowInputParameters')
class-attribute
¶
Input parameters for the flow run.
FLOW_PARENT_UNIT: RelationField = RelationField('flowParentUnit')
class-attribute
¶
TBC
FLOW_PROJECT_NAME: KeywordTextField = KeywordTextField('flowProjectName', 'flowProjectName.keyword', 'flowProjectName')
class-attribute
¶
Simple name of the project in which this asset is contained.
FLOW_PROJECT_QUALIFIED_NAME: KeywordField = KeywordField('flowProjectQualifiedName', 'flowProjectQualifiedName')
class-attribute
¶
Unique name of the project in which this asset is contained.
FLOW_QUERY: KeywordField = KeywordField('flowQuery', 'flowQuery')
class-attribute
¶
Query (e.g. SQL) that was run to produce this ephemeral piece of data.
FLOW_REUSABLE_UNIT_NAME: KeywordTextField = KeywordTextField('flowReusableUnitName', 'flowReusableUnitName.keyword', 'flowReusableUnitName')
class-attribute
¶
Simple name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_REUSABLE_UNIT_QUALIFIED_NAME: KeywordField = KeywordField('flowReusableUnitQualifiedName', 'flowReusableUnitQualifiedName')
class-attribute
¶
Unique name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_RUN_ID: KeywordField = KeywordField('flowRunId', 'flowRunId')
class-attribute
¶
Unique ID of the flow run, which could change on subsequent runs of the same flow.
FLOW_SCHEDULE: KeywordField = KeywordField('flowSchedule', 'flowSchedule')
class-attribute
¶
Schedule for this point in the data processing or orchestration.
FLOW_STARTED_AT: NumericField = NumericField('flowStartedAt', 'flowStartedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration started.
FLOW_STATUS: KeywordField = KeywordField('flowStatus', 'flowStatus')
class-attribute
¶
Overall status of this point in the data processing or orchestration.
FLOW_TYPE: KeywordField = KeywordField('flowType', 'flowType')
class-attribute
¶
Type of the ephemeral piece of data.
FlowDatasetOperation¶
pyatlan.model.assets.core.flow_dataset_operation.FlowDatasetOperation(__pydantic_self__, **data: Any)
¶
Bases: Process
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ADDITIONAL_ETL_CONTEXT: TextField = TextField('additionalEtlContext', 'additionalEtlContext')
class-attribute
¶
Additional Context of the ETL pipeline/notebook which creates the process.
AI_DATASET_TYPE: KeywordField = KeywordField('aiDatasetType', 'aiDatasetType')
class-attribute
¶
Dataset type for AI Model - dataset process.
AST: TextField = TextField('ast', 'ast')
class-attribute
¶
Parsed AST of the code or SQL statements that describe the logic of this process.
CODE: TextField = TextField('code', 'code')
class-attribute
¶
Code that ran within the process.
FLOW_ERROR_MESSAGE: KeywordField = KeywordField('flowErrorMessage', 'flowErrorMessage')
class-attribute
¶
Optional error message of the flow run.
FLOW_FINISHED_AT: NumericField = NumericField('flowFinishedAt', 'flowFinishedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration finished.
FLOW_FOLDER_NAME: KeywordTextField = KeywordTextField('flowFolderName', 'flowFolderName.keyword', 'flowFolderName')
class-attribute
¶
Simple name of the folder in which this asset is contained.
FLOW_FOLDER_QUALIFIED_NAME: KeywordField = KeywordField('flowFolderQualifiedName', 'flowFolderQualifiedName')
class-attribute
¶
Unique name of the folder in which this asset is contained.
FLOW_ID: KeywordField = KeywordField('flowId', 'flowId')
class-attribute
¶
Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.
FLOW_INPUT_PARAMETERS: KeywordField = KeywordField('flowInputParameters', 'flowInputParameters')
class-attribute
¶
Input parameters for the flow run.
FLOW_PROJECT_NAME: KeywordTextField = KeywordTextField('flowProjectName', 'flowProjectName.keyword', 'flowProjectName')
class-attribute
¶
Simple name of the project in which this asset is contained.
FLOW_PROJECT_QUALIFIED_NAME: KeywordField = KeywordField('flowProjectQualifiedName', 'flowProjectQualifiedName')
class-attribute
¶
Unique name of the project in which this asset is contained.
FLOW_REUSABLE_UNIT: RelationField = RelationField('flowReusableUnit')
class-attribute
¶
TBC
FLOW_REUSABLE_UNIT_NAME: KeywordTextField = KeywordTextField('flowReusableUnitName', 'flowReusableUnitName.keyword', 'flowReusableUnitName')
class-attribute
¶
Simple name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_REUSABLE_UNIT_QUALIFIED_NAME: KeywordField = KeywordField('flowReusableUnitQualifiedName', 'flowReusableUnitQualifiedName')
class-attribute
¶
Unique name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_RUN_ID: KeywordField = KeywordField('flowRunId', 'flowRunId')
class-attribute
¶
Unique ID of the flow run, which could change on subsequent runs of the same flow.
FLOW_SCHEDULE: KeywordField = KeywordField('flowSchedule', 'flowSchedule')
class-attribute
¶
Schedule for this point in the data processing or orchestration.
FLOW_STARTED_AT: NumericField = NumericField('flowStartedAt', 'flowStartedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration started.
FLOW_STATUS: KeywordField = KeywordField('flowStatus', 'flowStatus')
class-attribute
¶
Overall status of this point in the data processing or orchestration.
PARENT_CONNECTION_PROCESS_QUALIFIED_NAME: KeywordField = KeywordField('parentConnectionProcessQualifiedName', 'parentConnectionProcessQualifiedName')
class-attribute
¶
SQL: TextField = TextField('sql', 'sql')
class-attribute
¶
SQL query that ran to produce the outputs.
FlowField¶
pyatlan.model.assets.core.flow_field.FlowField(__pydantic_self__, **data: Any)
¶
Bases: Catalog
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
FLOW_DATASET: RelationField = RelationField('flowDataset')
class-attribute
¶
TBC
FLOW_DATASET_NAME: KeywordTextField = KeywordTextField('flowDatasetName', 'flowDatasetName.keyword', 'flowDatasetName')
class-attribute
¶
Simple name of the ephemeral dataset in which this field is contained.
FLOW_DATASET_QUALIFIED_NAME: KeywordField = KeywordField('flowDatasetQualifiedName', 'flowDatasetQualifiedName')
class-attribute
¶
Unique name of the ephemeral dataset in which this field is contained.
FLOW_DATA_TYPE: KeywordField = KeywordField('flowDataType', 'flowDataType')
class-attribute
¶
Type of the data captured in this field.
FLOW_ERROR_MESSAGE: KeywordField = KeywordField('flowErrorMessage', 'flowErrorMessage')
class-attribute
¶
Optional error message of the flow run.
FLOW_EXPRESSION: KeywordField = KeywordField('flowExpression', 'flowExpression')
class-attribute
¶
Logic that is applied, injected or otherwise used as part of producing this ephemeral field of data.
FLOW_FINISHED_AT: NumericField = NumericField('flowFinishedAt', 'flowFinishedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration finished.
FLOW_FOLDER_NAME: KeywordTextField = KeywordTextField('flowFolderName', 'flowFolderName.keyword', 'flowFolderName')
class-attribute
¶
Simple name of the folder in which this asset is contained.
FLOW_FOLDER_QUALIFIED_NAME: KeywordField = KeywordField('flowFolderQualifiedName', 'flowFolderQualifiedName')
class-attribute
¶
Unique name of the folder in which this asset is contained.
FLOW_ID: KeywordField = KeywordField('flowId', 'flowId')
class-attribute
¶
Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.
FLOW_INPUT_PARAMETERS: KeywordField = KeywordField('flowInputParameters', 'flowInputParameters')
class-attribute
¶
Input parameters for the flow run.
FLOW_PROJECT_NAME: KeywordTextField = KeywordTextField('flowProjectName', 'flowProjectName.keyword', 'flowProjectName')
class-attribute
¶
Simple name of the project in which this asset is contained.
FLOW_PROJECT_QUALIFIED_NAME: KeywordField = KeywordField('flowProjectQualifiedName', 'flowProjectQualifiedName')
class-attribute
¶
Unique name of the project in which this asset is contained.
FLOW_REUSABLE_UNIT_NAME: KeywordTextField = KeywordTextField('flowReusableUnitName', 'flowReusableUnitName.keyword', 'flowReusableUnitName')
class-attribute
¶
Simple name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_REUSABLE_UNIT_QUALIFIED_NAME: KeywordField = KeywordField('flowReusableUnitQualifiedName', 'flowReusableUnitQualifiedName')
class-attribute
¶
Unique name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_RUN_ID: KeywordField = KeywordField('flowRunId', 'flowRunId')
class-attribute
¶
Unique ID of the flow run, which could change on subsequent runs of the same flow.
FLOW_SCHEDULE: KeywordField = KeywordField('flowSchedule', 'flowSchedule')
class-attribute
¶
Schedule for this point in the data processing or orchestration.
FLOW_STARTED_AT: NumericField = NumericField('flowStartedAt', 'flowStartedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration started.
FLOW_STATUS: KeywordField = KeywordField('flowStatus', 'flowStatus')
class-attribute
¶
Overall status of this point in the data processing or orchestration.
FlowFieldOperation¶
pyatlan.model.assets.core.flow_field_operation.FlowFieldOperation(__pydantic_self__, **data: Any)
¶
Bases: ColumnProcess
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ADDITIONAL_ETL_CONTEXT: TextField = TextField('additionalEtlContext', 'additionalEtlContext')
class-attribute
¶
Additional Context of the ETL pipeline/notebook which creates the process.
AI_DATASET_TYPE: KeywordField = KeywordField('aiDatasetType', 'aiDatasetType')
class-attribute
¶
Dataset type for AI Model - dataset process.
AST: TextField = TextField('ast', 'ast')
class-attribute
¶
Parsed AST of the code or SQL statements that describe the logic of this process.
CODE: TextField = TextField('code', 'code')
class-attribute
¶
Code that ran within the process.
FLOW_ERROR_MESSAGE: KeywordField = KeywordField('flowErrorMessage', 'flowErrorMessage')
class-attribute
¶
Optional error message of the flow run.
FLOW_FINISHED_AT: NumericField = NumericField('flowFinishedAt', 'flowFinishedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration finished.
FLOW_FOLDER_NAME: KeywordTextField = KeywordTextField('flowFolderName', 'flowFolderName.keyword', 'flowFolderName')
class-attribute
¶
Simple name of the folder in which this asset is contained.
FLOW_FOLDER_QUALIFIED_NAME: KeywordField = KeywordField('flowFolderQualifiedName', 'flowFolderQualifiedName')
class-attribute
¶
Unique name of the folder in which this asset is contained.
FLOW_ID: KeywordField = KeywordField('flowId', 'flowId')
class-attribute
¶
Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.
FLOW_INPUT_PARAMETERS: KeywordField = KeywordField('flowInputParameters', 'flowInputParameters')
class-attribute
¶
Input parameters for the flow run.
FLOW_PROJECT_NAME: KeywordTextField = KeywordTextField('flowProjectName', 'flowProjectName.keyword', 'flowProjectName')
class-attribute
¶
Simple name of the project in which this asset is contained.
FLOW_PROJECT_QUALIFIED_NAME: KeywordField = KeywordField('flowProjectQualifiedName', 'flowProjectQualifiedName')
class-attribute
¶
Unique name of the project in which this asset is contained.
FLOW_REUSABLE_UNIT_NAME: KeywordTextField = KeywordTextField('flowReusableUnitName', 'flowReusableUnitName.keyword', 'flowReusableUnitName')
class-attribute
¶
Simple name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_REUSABLE_UNIT_QUALIFIED_NAME: KeywordField = KeywordField('flowReusableUnitQualifiedName', 'flowReusableUnitQualifiedName')
class-attribute
¶
Unique name of the reusable grouping of operations in which this ephemeral data is contained.
FLOW_RUN_ID: KeywordField = KeywordField('flowRunId', 'flowRunId')
class-attribute
¶
Unique ID of the flow run, which could change on subsequent runs of the same flow.
FLOW_SCHEDULE: KeywordField = KeywordField('flowSchedule', 'flowSchedule')
class-attribute
¶
Schedule for this point in the data processing or orchestration.
FLOW_STARTED_AT: NumericField = NumericField('flowStartedAt', 'flowStartedAt')
class-attribute
¶
Date and time at which this point in the data processing or orchestration started.
FLOW_STATUS: KeywordField = KeywordField('flowStatus', 'flowStatus')
class-attribute
¶
Overall status of this point in the data processing or orchestration.
PARENT_CONNECTION_PROCESS_QUALIFIED_NAME: KeywordField = KeywordField('parentConnectionProcessQualifiedName', 'parentConnectionProcessQualifiedName')
class-attribute
¶
SQL: TextField = TextField('sql', 'sql')
class-attribute
¶
SQL query that ran to produce the outputs.
FlowReusableUnit¶
pyatlan.model.assets.core.flow_reusable_unit.FlowReusableUnit(__pydantic_self__, **data: Any)
¶
Bases: Flow
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
FLOW_ABSTRACTS: RelationField = RelationField('flowAbstracts')
class-attribute
¶
TBC
FLOW_CONTROL_OPERATION_COUNT: NumericField = NumericField('flowControlOperationCount', 'flowControlOperationCount')
class-attribute
¶
Count of the number of control flow operations that execute this reusable unit.
FLOW_DATASETS: RelationField = RelationField('flowDatasets')
class-attribute
¶
TBC
FLOW_DATASET_COUNT: NumericField = NumericField('flowDatasetCount', 'flowDatasetCount')
class-attribute
¶
Count of the number of ephemeral datasets contained within this reusable unit.
FLOW_DATA_FLOWS: RelationField = RelationField('flowDataFlows')
class-attribute
¶
TBC
Folder¶
pyatlan.model.assets.core.folder.Folder(__pydantic_self__, **data: Any)
¶
Bases: Namespace
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
COLLECTION_QUALIFIED_NAME: KeywordTextField = KeywordTextField('collectionQualifiedName', 'collectionQualifiedName', 'collectionQualifiedName.text')
class-attribute
¶
Unique name of the collection in which this folder exists.
PARENT: RelationField = RelationField('parent')
class-attribute
¶
TBC
PARENT_QUALIFIED_NAME: KeywordTextField = KeywordTextField('parentQualifiedName', 'parentQualifiedName', 'parentQualifiedName.text')
class-attribute
¶
Unique name of the parent folder or collection in which this folder exists.
Namespace¶
pyatlan.model.assets.core.namespace.Namespace(__pydantic_self__, **data: Any)
¶
Process¶
pyatlan.model.assets.core.process.Process(__pydantic_self__, **data: Any)
¶
Bases: Asset
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ADDITIONAL_ETL_CONTEXT: TextField = TextField('additionalEtlContext', 'additionalEtlContext')
class-attribute
¶
Additional Context of the ETL pipeline/notebook which creates the process.
ADF_ACTIVITY: RelationField = RelationField('adfActivity')
class-attribute
¶
TBC
AIRFLOW_TASKS: RelationField = RelationField('airflowTasks')
class-attribute
¶
TBC
AI_DATASET_TYPE: KeywordField = KeywordField('aiDatasetType', 'aiDatasetType')
class-attribute
¶
Dataset type for AI Model - dataset process.
AST: TextField = TextField('ast', 'ast')
class-attribute
¶
Parsed AST of the code or SQL statements that describe the logic of this process.
BIGQUERY_ROUTINES: RelationField = RelationField('bigqueryRoutines')
class-attribute
¶
TBC
CODE: TextField = TextField('code', 'code')
class-attribute
¶
Code that ran within the process.
COLUMN_PROCESSES: RelationField = RelationField('columnProcesses')
class-attribute
¶
TBC
FABRIC_ACTIVITIES: RelationField = RelationField('fabricActivities')
class-attribute
¶
TBC
FIVETRAN_CONNECTOR: RelationField = RelationField('fivetranConnector')
class-attribute
¶
TBC
FLOW_ORCHESTRATED_BY: RelationField = RelationField('flowOrchestratedBy')
class-attribute
¶
TBC
MATILLION_COMPONENT: RelationField = RelationField('matillionComponent')
class-attribute
¶
TBC
PARENT_CONNECTION_PROCESS_QUALIFIED_NAME: KeywordField = KeywordField('parentConnectionProcessQualifiedName', 'parentConnectionProcessQualifiedName')
class-attribute
¶
POWER_BI_DATAFLOW: RelationField = RelationField('powerBIDataflow')
class-attribute
¶
TBC
SPARK_JOBS: RelationField = RelationField('sparkJobs')
class-attribute
¶
TBC
SQL: TextField = TextField('sql', 'sql')
class-attribute
¶
SQL query that ran to produce the outputs.
SQL_FUNCTIONS: RelationField = RelationField('sqlFunctions')
class-attribute
¶
TBC
SQL_PROCEDURES: RelationField = RelationField('sqlProcedures')
class-attribute
¶
TBC
Referenceable¶
pyatlan.model.assets.core.referenceable.Referenceable(__pydantic_self__, **data: Any)
¶
Bases: AtlanObject
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ASSIGNED_TERMS: KeywordTextField = InternalKeywordTextField('meanings', '__meanings', '__meaningsText', '__meanings')
class-attribute
¶
All terms attached to an asset, searchable by the term's qualifiedName.
ATLAN_TAGS: KeywordTextField = InternalKeywordTextField('classificationNames', '__traitNames', '__classificationsText', '__classificationNames')
class-attribute
¶
All directly-assigned Atlan tags that exist on an asset, searchable by internal hashed-string ID of the Atlan tag.
CREATED_BY: KeywordField = InternalKeywordField('createdBy', '__createdBy', '__createdBy')
class-attribute
¶
Atlan user who created this asset.
CREATE_TIME: NumericField = InternalNumericField('createTime', '__timestamp', '__timestamp')
class-attribute
¶
Time (in milliseconds) when the asset was created.
CUSTOM_ATTRIBUTES: TextField = TextField('__customAttributes', '__customAttributes')
class-attribute
¶
Any source-provided custom information. NOTE: This is NOT the same as custom metadata (user-managed), but is an entirely different area of source-managed custom information.
GUID: KeywordField = InternalKeywordField('guid', '__guid', '__guid')
class-attribute
¶
Globally unique identifier (GUID) of any object in Atlan.
PROPAGATED_ATLAN_TAGS: KeywordTextField = InternalKeywordTextField('classificationNames', '__propagatedTraitNames', '__classificationsText', '__propagatedClassificationNames')
class-attribute
¶
All propagated Atlan tags that exist on an asset, searchable by internal hashed-string ID of the Atlan tag.
QUALIFIED_NAME: KeywordTextField = KeywordTextField('qualifiedName', 'qualifiedName', 'qualifiedName.text')
class-attribute
¶
Unique fully-qualified name of the asset in Atlan.
STATUS: KeywordField = InternalKeywordField('status', '__state', '__state')
class-attribute
¶
Asset status in Atlan (active vs deleted).
SUPER_TYPE_NAMES: KeywordTextField = InternalKeywordTextField('typeName', '__superTypeNames.keyword', '__superTypeNames', '__superTypeNames')
class-attribute
¶
All super types of an asset.
TYPE_NAME: KeywordTextField = InternalKeywordTextField('typeName', '__typeName.keyword', '__typeName', '__typeName')
class-attribute
¶
Type of the asset. For example Table, Column, and so on.
UPDATED_BY: KeywordField = InternalKeywordField('updatedBy', '__modifiedBy', '__modifiedBy')
class-attribute
¶
Atlan user who last updated the asset.
UPDATE_TIME: NumericField = InternalNumericField('updateTime', '__modificationTimestamp', '__modificationTimestamp')
class-attribute
¶
Time (in milliseconds) when the asset was last updated.
Functions¶
can_be_archived() -> bool
classmethod
¶
Indicates if an asset can be archived via the asset.delete_by_guid method. :returns: True if archiving is supported
flush_custom_metadata_async(client: AsyncAtlanClient)
async
¶
Async version of flush_custom_metadata.
:param client: async Atlan client to use for the request
Source code in pyatlan/model/assets/core/referenceable.py
get_custom_metadata_async(client: AsyncAtlanClient, name: str)
async
¶
Async version of get_custom_metadata.
:param client: async Atlan client to use for the request :param name: human-readable name of the custom metadata set to retrieve :returns: the requested custom metadata set, or an empty one if none exists
Source code in pyatlan/model/assets/core/referenceable.py
json_async(*args, **kwargs) -> str
async
¶
Async version of json() method for use with AsyncAtlanClient. This properly handles async metadata proxy and sets business_attributes.
Source code in pyatlan/model/assets/core/referenceable.py
set_custom_metadata_async(client: AsyncAtlanClient, custom_metadata)
async
¶
Async version of set_custom_metadata.
:param client: async Atlan client to use for the request :param custom_metadata: the custom metadata to set on this asset
Source code in pyatlan/model/assets/core/referenceable.py
Resource¶
pyatlan.model.assets.core.resource.Resource(__pydantic_self__, **data: Any)
¶
Bases: Catalog
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
IS_GLOBAL: BooleanField = BooleanField('isGlobal', 'isGlobal')
class-attribute
¶
Whether the resource is global (true) or not (false).
LINK: TextField = TextField('link', 'link')
class-attribute
¶
URL to the resource.
REFERENCE: TextField = TextField('reference', 'reference')
class-attribute
¶
Reference to the resource.
RESOURCE_METADATA: KeywordField = KeywordField('resourceMetadata', 'resourceMetadata')
class-attribute
¶
Metadata of the resource.
SchemaRegistry¶
pyatlan.model.assets.core.schema_registry.SchemaRegistry(__pydantic_self__, **data: Any)
¶
Bases: Catalog
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
SCHEMA_REGISTRY_SCHEMA_ID: KeywordField = KeywordField('schemaRegistrySchemaId', 'schemaRegistrySchemaId')
class-attribute
¶
Unique identifier for schema definition set by the schema registry.
SCHEMA_REGISTRY_SCHEMA_TYPE: KeywordField = KeywordField('schemaRegistrySchemaType', 'schemaRegistrySchemaType')
class-attribute
¶
Type of language or specification used to define the schema, for example: JSON, Protobuf, etc.
SchemaRegistrySubject¶
pyatlan.model.assets.core.schema_registry_subject.SchemaRegistrySubject(__pydantic_self__, **data: Any)
¶
Bases: SchemaRegistry
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ASSETS: RelationField = RelationField('assets')
class-attribute
¶
TBC
SCHEMA_REGISTRY_SUBJECT_BASE_NAME: KeywordField = KeywordField('schemaRegistrySubjectBaseName', 'schemaRegistrySubjectBaseName')
class-attribute
¶
Base name of the subject, without -key, -value prefixes.
SCHEMA_REGISTRY_SUBJECT_GOVERNING_ASSET_QUALIFIED_NAMES: KeywordField = KeywordField('schemaRegistrySubjectGoverningAssetQualifiedNames', 'schemaRegistrySubjectGoverningAssetQualifiedNames')
class-attribute
¶
List of asset qualified names that this subject is governing/validating.
SCHEMA_REGISTRY_SUBJECT_IS_KEY_SCHEMA: BooleanField = BooleanField('schemaRegistrySubjectIsKeySchema', 'schemaRegistrySubjectIsKeySchema')
class-attribute
¶
Whether the subject is a schema for the keys of the messages (true) or not (false).
SCHEMA_REGISTRY_SUBJECT_LATEST_SCHEMA_DEFINITION: TextField = TextField('schemaRegistrySubjectLatestSchemaDefinition', 'schemaRegistrySubjectLatestSchemaDefinition')
class-attribute
¶
Definition of the latest schema in the subject.
SCHEMA_REGISTRY_SUBJECT_LATEST_SCHEMA_VERSION: KeywordField = KeywordField('schemaRegistrySubjectLatestSchemaVersion', 'schemaRegistrySubjectLatestSchemaVersion')
class-attribute
¶
Latest schema version of the subject.
SCHEMA_REGISTRY_SUBJECT_SCHEMA_COMPATIBILITY: KeywordField = KeywordField('schemaRegistrySubjectSchemaCompatibility', 'schemaRegistrySubjectSchemaCompatibility')
class-attribute
¶
Compatibility of the schema across versions.
Tag¶
pyatlan.model.assets.core.tag.Tag(__pydantic_self__, **data: Any)
¶
Bases: Catalog
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
MAPPED_CLASSIFICATION_NAME: KeywordField = KeywordField('mappedClassificationName', 'mappedClassificationName')
class-attribute
¶
Name of the classification in Atlan that is mapped to this tag.
TAG_ALLOWED_VALUES: KeywordTextField = KeywordTextField('tagAllowedValues', 'tagAllowedValues', 'tagAllowedValues.text')
class-attribute
¶
Allowed values for the tag in the source system. These are denormalized from tagAttributes for ease of querying.
TAG_ATTRIBUTES: KeywordField = KeywordField('tagAttributes', 'tagAttributes')
class-attribute
¶
Attributes associated with the tag in the source system.
TAG_ID: KeywordField = KeywordField('tagId', 'tagId')
class-attribute
¶
Unique identifier of the tag in the source system.