Skip to content

Other

Connection

pyatlan.model.assets.connection.Connection(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ALLOW_QUERY: BooleanField = BooleanField('allowQuery', 'allowQuery') class-attribute

Whether using this connection to run queries on the source is allowed (true) or not (false).

ALLOW_QUERY_PREVIEW: BooleanField = BooleanField('allowQueryPreview', 'allowQueryPreview') class-attribute

Whether using this connection to run preview queries on the source is allowed (true) or not (false).

CATEGORY: TextField = TextField('category', 'category') class-attribute

Type of connection, for example WAREHOUSE, RDBMS, etc.

CONNECTION_DBT_ENVIRONMENTS: KeywordField = KeywordField('connectionDbtEnvironments', 'connectionDbtEnvironments') class-attribute

CONNECTION_DQ_CREDENTIAL_GUID: KeywordField = KeywordField('connectionDQCredentialGuid', 'connectionDQCredentialGuid') class-attribute

Unique identifier (GUID) for the data quality credentials to use for this connection.

CONNECTION_DQ_ENVIRONMENT_SETUP_ERROR_MESSAGE: TextField = TextField('connectionDQEnvironmentSetupErrorMessage', 'connectionDQEnvironmentSetupErrorMessage') class-attribute

Error message if data quality environment setup failed for this connection.

CONNECTION_DQ_ENVIRONMENT_SETUP_STATUS: KeywordField = KeywordField('connectionDQEnvironmentSetupStatus', 'connectionDQEnvironmentSetupStatus') class-attribute

Status of the data quality environment setup for this connection.

CONNECTION_DQ_ENVIRONMENT_SETUP_STATUS_UPDATED_AT: NumericField = NumericField('connectionDQEnvironmentSetupStatusUpdatedAt', 'connectionDQEnvironmentSetupStatusUpdatedAt') class-attribute

Timestamp when the data quality environment setup status was last updated.

CONNECTION_DQ_ENVIRONMENT_SOURCE_DATABASE_NAME: KeywordField = KeywordField('connectionDQEnvironmentSourceDatabaseName', 'connectionDQEnvironmentSourceDatabaseName') class-attribute

Name of the database in the source environment for data quality.

Whether cookie based OAuth is enabled in Insights for this connection (true) or not (false).

CONNECTION_IS_DQ_ENABLED: BooleanField = BooleanField('connectionIsDQEnabled', 'connectionIsDQEnabled') class-attribute

Whether data quality is enabled for this connection (true) or not (false).

CONNECTION_SSO_CREDENTIAL_GUID: KeywordField = KeywordField('connectionSSOCredentialGuid', 'connectionSSOCredentialGuid') class-attribute

Unique identifier (GUID) for the SSO credentials to use for this connection.

CONNECTION_WORKFLOW_CONFIGURATION: KeywordField = KeywordField('connectionWorkflowConfiguration', 'connectionWorkflowConfiguration') class-attribute

Configuration for a workflow run.

CONNECTOR_ICON: TextField = TextField('connectorIcon', 'connectorIcon') class-attribute

Unused. Only the value of connectorType impacts icons.

CONNECTOR_IMAGE: TextField = TextField('connectorImage', 'connectorImage') class-attribute

Unused. Only the value of connectorType impacts icons.

CREDENTIAL_STRATEGY: TextField = TextField('credentialStrategy', 'credentialStrategy') class-attribute

Credential strategy to use for this connection for queries.

DEFAULT_CREDENTIAL_GUID: TextField = TextField('defaultCredentialGuid', 'defaultCredentialGuid') class-attribute

Unique identifier (GUID) for the default credentials to use for this connection.

HAS_POPULARITY_INSIGHTS: BooleanField = BooleanField('hasPopularityInsights', 'hasPopularityInsights') class-attribute

Whether this connection has popularity insights (true) or not (false).

HOST: TextField = TextField('host', 'host') class-attribute

Host name of this connection's source.

INPUT_TO_CONNECTION_PROCESSES: RelationField = RelationField('inputToConnectionProcesses') class-attribute

TBC

IS_SAMPLE_DATA_PREVIEW_ENABLED: BooleanField = BooleanField('isSampleDataPreviewEnabled', 'isSampleDataPreviewEnabled') class-attribute

Whether sample data can be previewed for this connection (true) or not (false).

OBJECT_STORAGE_UPLOAD_THRESHOLD: NumericField = NumericField('objectStorageUploadThreshold', 'objectStorageUploadThreshold') class-attribute

Number of rows after which results should be uploaded to storage.

OUTPUT_FROM_CONNECTION_PROCESSES: RelationField = RelationField('outputFromConnectionProcesses') class-attribute

TBC

POLICY_STRATEGY: KeywordField = KeywordField('policyStrategy', 'policyStrategy') class-attribute

Policy strategy is a configuration that determines whether the Atlan policy will be applied to the results of insight queries and whether the query will be rewritten, applicable for stream api call made from insight screen

POLICY_STRATEGY_FOR_SAMPLE_PREVIEW: KeywordField = KeywordField('policyStrategyForSamplePreview', 'policyStrategyForSamplePreview') class-attribute

Policy strategy is a configuration that determines whether the Atlan policy will be applied to the results of insight queries and whether the query will be rewritten. policyStrategyForSamplePreview config is applicable for sample preview call from assets screen

POPULARITY_INSIGHTS_TIMEFRAME: NumericField = NumericField('popularityInsightsTimeframe', 'popularityInsightsTimeframe') class-attribute

Number of days over which popularity is calculated, for example 30 days.

PORT: NumericField = NumericField('port', 'port') class-attribute

Port number to this connection's source.

PREVIEW_CREDENTIAL_STRATEGY: KeywordField = KeywordField('previewCredentialStrategy', 'previewCredentialStrategy') class-attribute

Credential strategy to use for this connection for preview queries.

QUERY_CONFIG: TextField = TextField('queryConfig', 'queryConfig') class-attribute

Query config for this connection.

QUERY_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig') class-attribute

Configuration for preview queries.

QUERY_TIMEOUT: NumericField = NumericField('queryTimeout', 'queryTimeout') class-attribute

Maximum time a query should be allowed to run before timing out.

QUERY_USERNAME_STRATEGY: KeywordField = KeywordField('queryUsernameStrategy', 'queryUsernameStrategy') class-attribute

Username strategy to use for this connection for queries.

ROW_LIMIT: NumericField = NumericField('rowLimit', 'rowLimit') class-attribute

Maximum number of rows that can be returned for the source.

Unused. Only the value of connectorType impacts icons.

SUB_CATEGORY: TextField = TextField('subCategory', 'subCategory') class-attribute

Subcategory of this connection.

USE_OBJECT_STORAGE: BooleanField = BooleanField('useObjectStorage', 'useObjectStorage') class-attribute

Whether to upload to S3, GCP, or another storage location (true) or not (false).

VECTOR_EMBEDDINGS_ENABLED: BooleanField = BooleanField('vectorEmbeddingsEnabled', 'vectorEmbeddingsEnabled') class-attribute

VECTOR_EMBEDDINGS_UPDATED_AT: NumericField = NumericField('vectorEmbeddingsUpdatedAt', 'vectorEmbeddingsUpdatedAt') class-attribute

Functions

creator_async(*, client: AsyncAtlanClient, name: str, connector_type: AtlanConnectorType, admin_users: Optional[List[str]] = None, admin_groups: Optional[List[str]] = None, admin_roles: Optional[List[str]] = None, host: Optional[str] = None, port: Optional[int] = None) -> Connection async classmethod

Async version of creator() method for creating a new connection.

:param client: async client to use for validation :param name: name for the connection :param connector_type: type of connector this connection is for :param admin_users: list of admin usernames for the connection :param admin_groups: list of admin group names for the connection :param admin_roles: list of admin role GUIDs for the connection :param host: hostname for the connection :param port: port number for the connection :returns: the new connection object :raises ValueError: if required parameters are missing or invalid

Source code in pyatlan/model/assets/connection.py 
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
@classmethod
@init_guid
async def creator_async(
    cls,
    *,
    client: AsyncAtlanClient,
    name: str,
    connector_type: AtlanConnectorType,
    admin_users: Optional[List[str]] = None,
    admin_groups: Optional[List[str]] = None,
    admin_roles: Optional[List[str]] = None,
    host: Optional[str] = None,
    port: Optional[int] = None,
) -> Connection:
    """
    Async version of creator() method for creating a new connection.

    :param client: async client to use for validation
    :param name: name for the connection
    :param connector_type: type of connector this connection is for
    :param admin_users: list of admin usernames for the connection
    :param admin_groups: list of admin group names for the connection
    :param admin_roles: list of admin role GUIDs for the connection
    :param host: hostname for the connection
    :param port: port number for the connection
    :returns: the new connection object
    :raises ValueError: if required parameters are missing or invalid
    """
    validate_required_fields(
        ["client", "name", "connector_type"], [client, name, connector_type]
    )
    if not admin_users and not admin_groups and not admin_roles:
        raise ValueError(
            "One of admin_user, admin_groups or admin_roles is required"
        )
    attr = cls.Attributes(
        name=name,
        qualified_name=connector_type.to_qualified_name(),
        connector_name=connector_type.value,
        category=connector_type.category.value,
    )

    # Use async cache validation methods
    await client.user_cache.validate_names(names=admin_users or [])
    await client.role_cache.validate_idstrs(idstrs=admin_roles or [])
    await client.group_cache.validate_aliases(aliases=admin_groups or [])

    attr.admin_users = set() if admin_users is None else set(admin_users)
    attr.admin_groups = set() if admin_groups is None else set(admin_groups)
    attr.admin_roles = set() if admin_roles is None else set(admin_roles)

    attr.host = host
    attr.port = port
    return cls(attributes=attr)

ConnectionProcess

pyatlan.model.assets.connection_process.ConnectionProcess(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Workflow

pyatlan.model.assets.workflow.Workflow(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

WORKFLOW_ACTION_CHOICES: KeywordField = KeywordField('workflowActionChoices', 'workflowActionChoices') class-attribute

List of workflow action choices.

WORKFLOW_CONFIG: TextField = TextField('workflowConfig', 'workflowConfig') class-attribute

Details of the workflow.

WORKFLOW_CREATED_BY: KeywordField = KeywordField('workflowCreatedBy', 'workflowCreatedBy') class-attribute

Username of the user who created this workflow.

WORKFLOW_DELETED_AT: NumericField = NumericField('workflowDeletedAt', 'workflowDeletedAt') class-attribute

Deletion time of this workflow.

WORKFLOW_RUN_EXPIRES_IN: TextField = TextField('workflowRunExpiresIn', 'workflowRunExpiresIn') class-attribute

Time duration after which a run of this workflow will expire.

WORKFLOW_STATUS: KeywordField = KeywordField('workflowStatus', 'workflowStatus') class-attribute

Status of the workflow.

WORKFLOW_TEMPLATE_GUID: KeywordField = KeywordField('workflowTemplateGuid', 'workflowTemplateGuid') class-attribute

GUID of the workflow template from which this workflow was created.

WORKFLOW_TYPE: KeywordField = KeywordField('workflowType', 'workflowType') class-attribute

Type of the workflow.

WORKFLOW_UPDATED_BY: KeywordField = KeywordField('workflowUpdatedBy', 'workflowUpdatedBy') class-attribute

Username of the user who updated this workflow.

WorkflowRun

pyatlan.model.assets.workflow_run.WorkflowRun(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

WORKFLOW_RUN_ACTION_CHOICES: KeywordField = KeywordField('workflowRunActionChoices', 'workflowRunActionChoices') class-attribute

List of workflow run action choices.

WORKFLOW_RUN_COMMENT: TextField = TextField('workflowRunComment', 'workflowRunComment') class-attribute

The comment added by the requester

WORKFLOW_RUN_CONFIG: TextField = TextField('workflowRunConfig', 'workflowRunConfig') class-attribute

Details of the approval workflow run.

WORKFLOW_RUN_CREATED_BY: KeywordField = KeywordField('workflowRunCreatedBy', 'workflowRunCreatedBy') class-attribute

Username of the user who created this workflow run.

WORKFLOW_RUN_DELETED_AT: NumericField = NumericField('workflowRunDeletedAt', 'workflowRunDeletedAt') class-attribute

Deletion time of this workflow run.

WORKFLOW_RUN_EXPIRES_AT: NumericField = NumericField('workflowRunExpiresAt', 'workflowRunExpiresAt') class-attribute

Time at which this run will expire.

WORKFLOW_RUN_ON_ASSET_GUID: KeywordField = KeywordField('workflowRunOnAssetGuid', 'workflowRunOnAssetGuid') class-attribute

The asset for which this run was created.

WORKFLOW_RUN_STATUS: KeywordField = KeywordField('workflowRunStatus', 'workflowRunStatus') class-attribute

Status of the run.

WORKFLOW_RUN_TYPE: KeywordField = KeywordField('workflowRunType', 'workflowRunType') class-attribute

Type of the workflow from which this run was created.

WORKFLOW_RUN_UPDATED_BY: KeywordField = KeywordField('workflowRunUpdatedBy', 'workflowRunUpdatedBy') class-attribute

Username of the user who updated this workflow run.

WORKFLOW_RUN_WORKFLOW_GUID: KeywordField = KeywordField('workflowRunWorkflowGuid', 'workflowRunWorkflowGuid') class-attribute

GUID of the workflow from which this run was created.

Notebook

pyatlan.model.assets.notebook.Notebook(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Collection

pyatlan.model.assets.collection.Collection(__pydantic_self__, **data: Any)

Bases: Namespace

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ICON: TextField = TextField('icon', 'icon') class-attribute

Image used to represent this collection.

ICON_TYPE: KeywordField = KeywordField('iconType', 'iconType') class-attribute

Type of image used to represent the collection (for example, an emoji).

Custom

pyatlan.model.assets.custom.Custom(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

CustomEntity

pyatlan.model.assets.custom_entity.CustomEntity(__pydantic_self__, **data: Any)

Bases: Custom

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

CUSTOM_CHILDREN_SUBTYPE: KeywordField = KeywordField('customChildrenSubtype', 'customChildrenSubtype') class-attribute

Label of the children column for this asset type.

CUSTOM_CHILD_ENTITIES: RelationField = RelationField('customChildEntities') class-attribute

TBC

CUSTOM_PARENT_ENTITY: RelationField = RelationField('customParentEntity') class-attribute

TBC

TBC

TBC

Badge

pyatlan.model.assets.badge.Badge(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

BADGE_CONDITIONS: KeywordField = KeywordField('badgeConditions', 'badgeConditions') class-attribute

List of conditions that determine the colors to diplay for various values.

BADGE_METADATA_ATTRIBUTE: KeywordField = KeywordField('badgeMetadataAttribute', 'badgeMetadataAttribute') class-attribute

Custom metadata attribute for which to show the badge.

TagAttachment

pyatlan.model.assets.tag_attachment.TagAttachment(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

TAG_ATTACHMENT_STRING_VALUE: KeywordTextField = KeywordTextField('tagAttachmentStringValue', 'tagAttachmentStringValue', 'tagAttachmentStringValue.text') class-attribute

Represents associated tag value.

TAG_QUALIFIED_NAME: KeywordTextField = KeywordTextField('tagQualifiedName', 'tagQualifiedName', 'tagQualifiedName.text') class-attribute

Represents associated source tag's qualified name.

SourceTag

pyatlan.model.assets.source_tag.SourceTag(__pydantic_self__, **data: Any)

Bases: Tag

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

TAG_CUSTOM_CONFIGURATION: KeywordField = KeywordField('tagCustomConfiguration', 'tagCustomConfiguration') class-attribute

Specifies custom configuration elements based on the system the tag is being imported from.

Task

pyatlan.model.assets.task.Task(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

TASK_ACTIONS: KeywordField = KeywordField('taskActions', 'taskActions') class-attribute

List of actions associated with this task.

TASK_CREATED_BY: KeywordField = KeywordField('taskCreatedBy', 'taskCreatedBy') class-attribute

Username of the user who created this task.

TASK_EXECUTION_ACTION: KeywordField = KeywordField('taskExecutionAction', 'taskExecutionAction') class-attribute

Action executed by the recipient.

TASK_EXECUTION_COMMENT: TextField = TextField('taskExecutionComment', 'taskExecutionComment') class-attribute

Comment for the action executed by user.

TASK_EXPIRES_AT: NumericField = NumericField('taskExpiresAt', 'taskExpiresAt') class-attribute

Time (epoch) at which the task expires.

TASK_INTEGRATION_CONFIG: TextField = TextField('taskIntegrationConfig', 'taskIntegrationConfig') class-attribute

Contains external integration config for the task.

TASK_IS_READ: BooleanField = BooleanField('taskIsRead', 'taskIsRead') class-attribute

Flag to make task read/unread.

TASK_PROPOSALS: TextField = TextField('taskProposals', 'taskProposals') class-attribute

Contains the payload that is proposed to the task.

TASK_RECIPIENT: KeywordField = KeywordField('taskRecipient', 'taskRecipient') class-attribute

Recipient of the task.

Unique identifier of the asset to preview.

TASK_REQUESTOR: KeywordField = KeywordField('taskRequestor', 'taskRequestor') class-attribute

Requestor of the task.

TASK_REQUESTOR_COMMENT: TextField = TextField('taskRequestorComment', 'taskRequestorComment') class-attribute

Comment of requestor for the task.

TASK_TYPE: KeywordField = KeywordField('taskType', 'taskType') class-attribute

Type of task.

TASK_UPDATED_BY: KeywordField = KeywordField('taskUpdatedBy', 'taskUpdatedBy') class-attribute

Username of the user who updated this task.

Form

pyatlan.model.assets.form.Form(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

FORM_FIELDS: KeywordField = KeywordField('formFields', 'formFields') class-attribute

Fields in a form.

FORM_OPTIONS: KeywordField = KeywordField('formOptions', 'formOptions') class-attribute

Options of the form.

DataSet

pyatlan.model.assets.data_set.DataSet(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Response

pyatlan.model.assets.response.Response(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

FORM_GUID: KeywordField = KeywordField('formGuid', 'formGuid') class-attribute

Unique identifier of the form.

RESPONSE_OPTIONS: KeywordField = KeywordField('responseOptions', 'responseOptions') class-attribute

Options of the response to a form.

RESPONSE_VALUES: KeywordField = KeywordField('responseValues', 'responseValues') class-attribute

Fields in a form.

Incident

pyatlan.model.assets.incident.Incident(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

INCIDENT_SEVERITY: KeywordField = KeywordField('incidentSeverity', 'incidentSeverity') class-attribute

Status of this asset's severity.

Insight

pyatlan.model.assets.insight.Insight(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

SaaS

pyatlan.model.assets.saa_s.SaaS(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

MultiDimensionalDataset

pyatlan.model.assets.multi_dimensional_dataset.MultiDimensionalDataset(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

CUBE_DIMENSION_NAME: KeywordTextField = KeywordTextField('cubeDimensionName', 'cubeDimensionName.keyword', 'cubeDimensionName') class-attribute

Simple name of the cube dimension in which this asset exists, or empty if it is itself a dimension.

CUBE_DIMENSION_QUALIFIED_NAME: KeywordField = KeywordField('cubeDimensionQualifiedName', 'cubeDimensionQualifiedName') class-attribute

Unique name of the cube dimension in which this asset exists, or empty if it is itself a dimension.

CUBE_HIERARCHY_NAME: KeywordTextField = KeywordTextField('cubeHierarchyName', 'cubeHierarchyName.keyword', 'cubeHierarchyName') class-attribute

Simple name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.

CUBE_HIERARCHY_QUALIFIED_NAME: KeywordField = KeywordField('cubeHierarchyQualifiedName', 'cubeHierarchyQualifiedName') class-attribute

Unique name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.

CUBE_NAME: KeywordTextField = KeywordTextField('cubeName', 'cubeName.keyword', 'cubeName') class-attribute

Simple name of the cube in which this asset exists, or empty if it is itself a cube.

CUBE_QUALIFIED_NAME: KeywordField = KeywordField('cubeQualifiedName', 'cubeQualifiedName') class-attribute

Unique name of the cube in which this asset exists, or empty if it is itself a cube.

Infrastructure

pyatlan.model.assets.infrastructure.Infrastructure(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

ProcessExecution

pyatlan.model.assets.process_execution.ProcessExecution(__pydantic_self__, **data: Any)

Bases: Asset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

ReadmeTemplate

pyatlan.model.assets.readme_template.ReadmeTemplate(__pydantic_self__, **data: Any)

Bases: Resource

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ICON: TextField = TextField('icon', 'icon') class-attribute

Icon to use for the README template.

ICON_TYPE: KeywordField = KeywordField('iconType', 'iconType') class-attribute

Type of icon, for example: image or emoji.

AtlanAppDeployment

pyatlan.model.assets.atlan_app_deployment.AtlanAppDeployment(__pydantic_self__, **data: Any)

Bases: AtlanApp

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ATLAN_APP_ERROR_DETAILS: KeywordField = KeywordField('atlanAppErrorDetails', 'atlanAppErrorDetails') class-attribute

Detailed error message explaining why the deployment failed. Should only be populated when status = FAILED.

ATLAN_APP_OPERATION: KeywordField = KeywordField('atlanAppOperation', 'atlanAppOperation') class-attribute

Type of operation requested.

ATLAN_APP_STATUS: KeywordField = KeywordField('atlanAppStatus', 'atlanAppStatus') class-attribute

Status of deployment.

ATLAN_APP_VERSION_ID: NumericField = NumericField('atlanAppVersionId', 'atlanAppVersionId') class-attribute

Version identifier for deployment.

ATLAN_APP_VERSION_UUID: KeywordField = KeywordField('atlanAppVersionUUID', 'atlanAppVersionUUID') class-attribute

Version uuid for deployment. This is externally exposed information.

AtlanAppInstalled

pyatlan.model.assets.atlan_app_installed.AtlanAppInstalled(__pydantic_self__, **data: Any)

Bases: AtlanApp

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

ATLAN_APP_CURRENT_VERSION_ID: NumericField = NumericField('atlanAppCurrentVersionId', 'atlanAppCurrentVersionId') class-attribute

Current version identifier for the atlan application.

ATLAN_APP_CURRENT_VERSION_UUID: KeywordField = KeywordField('atlanAppCurrentVersionUUID', 'atlanAppCurrentVersionUUID') class-attribute

Current version uuid for the atlan application. This is externally exposed information.

ATLAN_APP_DEPLOYMENT_CONFIG: KeywordField = KeywordField('atlanAppDeploymentConfig', 'atlanAppDeploymentConfig') class-attribute

Configuration settings used by the atlan application.

FlowFolder

pyatlan.model.assets.flow_folder.FlowFolder(__pydantic_self__, **data: Any)

Bases: Flow

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

FLOW_PARENT_FOLDER: RelationField = RelationField('flowParentFolder') class-attribute

TBC

FLOW_SUB_FOLDERS: RelationField = RelationField('flowSubFolders') class-attribute

TBC

FlowProject

pyatlan.model.assets.flow_project.FlowProject(__pydantic_self__, **data: Any)

Bases: Flow

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

App

pyatlan.model.assets.core.app.App(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

APP_ID: KeywordField = KeywordField('appId', 'appId') class-attribute

Unique identifier for the application asset from the source system.

Application

pyatlan.model.assets.core.application.Application(__pydantic_self__, **data: Any)

Bases: App

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

APPLICATION_CHILD_FIELDS: RelationField = RelationField('applicationChildFields') class-attribute

TBC

APPLICATION_OWNED_ASSETS: RelationField = RelationField('applicationOwnedAssets') class-attribute

TBC

ApplicationField

pyatlan.model.assets.core.application_field.ApplicationField(__pydantic_self__, **data: Any)

Bases: App

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

APPLICATION_FIELD_OWNED_ASSETS: RelationField = RelationField('applicationFieldOwnedAssets') class-attribute

TBC

APPLICATION_PARENT: RelationField = RelationField('applicationParent') class-attribute

TBC

APPLICATION_PARENT_QUALIFIED_NAME: KeywordField = KeywordField('applicationParentQualifiedName', 'applicationParentQualifiedName') class-attribute

Unique name of the parent Application asset that contains this ApplicationField asset.