TypeDef

class pyatlan.model.typedef.TypeDef(*, category: AtlanTypeCategory, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None)[source]
class pyatlan.model.typedef.AtlanTagDef(*, category: AtlanTypeCategory = AtlanTypeCategory.CLASSIFICATION, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None, attributeDefs: List[AttributeDef] | None = None, displayName: str = None, entityTypes: List[str] | None = None, options: Dict[str, Any] | None = None, subTypes: List[str] | None = None, superTypes: List[str] | None = None, serviceType: str | None = None, skipDisplayNameUniquenessCheck: bool | None = None)[source]
class pyatlan.model.typedef.CustomMetadataDef(*, category: AtlanTypeCategory = AtlanTypeCategory.CUSTOM_METADATA, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None, attributeDefs: List[AttributeDef] = None, displayName: str = None, options: CustomMetadataDef.Options | None = None)[source]
class pyatlan.model.typedef.AttributeDef(*, isNew: bool | None = None, cardinality: Cardinality | None = None, constraints: List[Dict[str, Any]] | None = None, enumValues: List[str] | None = None, description: str | None = None, defaultValue: str | None = None, displayName: str | None = None, name: str | None = None, includeInNotification: bool | None = None, indexType: IndexType | None = None, isIndexable: bool | None = None, isOptional: bool | None = None, isUnique: bool | None = None, options: AttributeDef.Options | None = None, searchWeight: float | None = None, skipScrubbing: bool | None = None, typeName: str | None = None, valuesMinCount: float | None = None, valuesMaxCount: float | None = None, indexTypeESConfig: Dict[str, str] | None = None, indexTypeESFields: Dict[str, Dict[str, str]] | None = None, isDefaultValueNull: bool | None = None)[source]
property applicable_asset_types: Set[str] | Set[Literal['ADLSAccount', 'ADLSContainer', 'ADLSObject', 'AnaplanPage', 'AnaplanList', 'AnaplanLineItem', 'AnaplanWorkspace', 'AnaplanModule', 'AnaplanModel', 'AnaplanApp', 'AnaplanDimension', 'AnaplanView', 'APIField', 'APIObject', 'APIPath', 'APIQuery', 'APISpec', 'Application', 'ApplicationField', 'Collection', 'Query', 'BIProcess', 'Badge', 'Column', 'ColumnProcess', 'Connection', 'CustomEntity', 'DataStudioAsset', 'DataverseAttribute', 'DataverseEntity', 'Database', 'DbtColumnProcess', 'DbtMetric', 'DbtModel', 'DbtModelColumn', 'DbtProcess', 'DbtSource', 'Folder', 'GCSBucket', 'GCSObject', 'Insight', 'KafkaConsumerGroup', 'KafkaTopic', 'Process', 'Link', 'LookerDashboard', 'LookerExplore', 'LookerField', 'LookerFolder', 'LookerLook', 'LookerModel', 'LookerProject', 'LookerQuery', 'LookerTile', 'LookerView', 'MCIncident', 'MCMonitor', 'MaterialisedView', 'MetabaseCollection', 'MetabaseDashboard', 'MetabaseQuestion', 'ModeChart', 'ModeCollection', 'ModeQuery', 'ModeReport', 'ModeWorkspace', 'PowerBIColumn', 'PowerBIDashboard', 'PowerBIDataflow', 'PowerBIDataset', 'PowerBIDatasource', 'PowerBIMeasure', 'PowerBIPage', 'PowerBIReport', 'PowerBITable', 'PowerBITile', 'PowerBIWorkspace', 'PresetChart', 'PresetDashboard', 'PresetDataset', 'PresetWorkspace', 'Procedure', 'QlikApp', 'QlikChart', 'QlikDataset', 'QlikSheet', 'QlikSpace', 'QlikStream', 'QuickSightAnalysis', 'QuickSightAnalysisVisual', 'QuickSightDashboard', 'QuickSightDashboardVisual', 'QuickSightDataset', 'QuickSightDatasetField', 'QuickSightFolder', 'Readme', 'ReadmeTemplate', 'RedashDashboard', 'RedashQuery', 'RedashVisualization', 'S3Bucket', 'S3Object', 'SalesforceDashboard', 'SalesforceField', 'SalesforceObject', 'SalesforceOrganization', 'SalesforceReport', 'Schema', 'SigmaDataElement', 'SigmaDataElementField', 'SigmaDataset', 'SigmaDatasetColumn', 'SigmaPage', 'SigmaWorkbook', 'SnowflakePipe', 'SnowflakeStream', 'SnowflakeTag', 'SupersetChart', 'SupersetDashboard', 'SupersetDataset', 'Table', 'TablePartition', 'TableauCalculatedField', 'TableauDashboard', 'TableauDatasource', 'TableauDatasourceField', 'TableauFlow', 'TableauMetric', 'TableauProject', 'TableauSite', 'TableauWorkbook', 'TableauWorksheet', 'ThoughtspotAnswer', 'ThoughtspotDashlet', 'ThoughtspotLiveboard', 'View']]

Asset type names to which to restrict the attribute. Only assets of one of these types will have this attribute available. To further restrict the assets for this custom metadata by connection, see applicable_connections.

property applicable_connections: Set[str]

Qualified names of connections to which to restrict the attribute. Only assets within one of these connections will have this attribute available. To further restrict the types of assets within the glossaries, see applicable_asset_types}.

property applicable_domain_types: Set[Literal['DataDomain', 'DataProduct']]

Data product type names to which to restrict the attribute. These cover asset types in data products and data domains. Only assets of one of these types will have this attribute available.

property applicable_domains: Set[str]

Qualified names of domains to which to restrict the attribute. Only domains and data products within one of these domains will have this attribute available. To further restrict the types of assets within the domains, see applicable_domain_types.

property applicable_entity_types: Set[Literal['Asset']]

Set of entities on which this attribute can be applied. Note: generally this should be left as-is. Any overrides should instead be applied through one or more of applicable_asset_types, applicable_glossary_types, or applicable_other_asset_types.

property applicable_glossaries: Set[str]

Qualified names of glossaries to which to restrict the attribute. Only glossary assets within one of these glossaries will have this attribute available. To further restrict the types of assets within the glossaries, see applicable_glossary_types.

property applicable_glossary_types: Set[Literal['AtlasGlossary', 'AtlasGlossaryCategory', 'AtlasGlossaryTerm']]

Glossary type names to which to restrict the attribute. Only glossary assets of one of these types will have this attribute available. To further restrict the glossary content for this custom metadata by glossary, see applicable_glossaries.

property applicable_other_asset_types: Set[Literal['File']]

Any other asset type names to which to restrict the attribute. These cover any asset type that is not managed within a connection or a glossary. Only assets of one of these types will have this attribute available.

class pyatlan.model.typedef.EnumDef(*, category: AtlanTypeCategory = AtlanTypeCategory.ENUM, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None, elementDefs: List[EnumDef.ElementDef], options: Dict[str, Any] | None = None, serviceType: str | None = None)[source]
static create(name: str, values: List[str]) → EnumDef[source]

Builds the minimal object necessary to create an enumeration definition.

Parameters:

  • name – display name the human-readable name for the enumeration

  • values – the list of additional valid values

(as strings) to add to the existing enumeration :returns: the minimal object necessary to create the enumeration typedef

get_valid_values() → List[str][source]

Translate the element definitions in this enumeration into simple list of strings.

static update(client: AtlanClient, name: str, values: List[str], replace_existing: bool) → EnumDef[source]

Builds the minimal object necessary to update an enumeration definition.

Parameters:

  • client – connectivity to an Atlan tenant

  • name – display name the human-readable name for the enumeration

  • values – the list of additional valid values

(as strings) to add to the existing enumeration :param replace_existing: if True, will replace all existing values in the enumeration with the new ones; or if False the new ones will be appended to the existing set :returns: the minimal object necessary to update the enumeration typedef

class pyatlan.model.typedef.RelationshipAttributeDef(*, isNew: bool | None = None, cardinality: Cardinality | None = None, constraints: List[Dict[str, Any]] | None = None, enumValues: List[str] | None = None, description: str | None = None, defaultValue: str | None = None, displayName: str | None = None, name: str | None = None, includeInNotification: bool | None = None, indexType: IndexType | None = None, isIndexable: bool | None = None, isOptional: bool | None = None, isUnique: bool | None = None, options: AttributeDef.Options | None = None, searchWeight: float | None = None, skipScrubbing: bool | None = None, typeName: str | None = None, valuesMinCount: float | None = None, valuesMaxCount: float | None = None, indexTypeESConfig: Dict[str, str] | None = None, indexTypeESFields: Dict[str, Dict[str, str]] | None = None, isDefaultValueNull: bool | None = None, isLegacyAttribute: bool | None = None, relationshipTypeName: str | None = None)[source]
class pyatlan.model.typedef.StructDef(*, category: AtlanTypeCategory = AtlanTypeCategory.STRUCT, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None, attributeDefs: List[AttributeDef] | None = None, serviceType: str | None = None)[source]
class pyatlan.model.typedef.EntityDef(*, category: AtlanTypeCategory = AtlanTypeCategory.ENTITY, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None, attributeDefs: List[Dict[str, Any]] | None = None, businessAttributeDefs: Dict[str, List[Dict[str, Any]]] | None = None, relationshipAttributeDefs: List[Dict[str, Any]] | None = None, serviceType: str | None = None, subTypes: List[str] | None = None, superTypes: List[str] | None = None)[source]
class pyatlan.model.typedef.RelationshipDef(*, category: AtlanTypeCategory = AtlanTypeCategory.RELATIONSHIP, createTime: int | None = None, createdBy: str | None = None, description: str | None = None, guid: str | None = None, name: str = None, typeVersion: str | None = None, updateTime: int | None = None, updatedBy: str | None = None, version: int | None = None, attributeDefs: List[Dict[str, Any]] | None = None, endDef1: Dict[str, Any] | None = None, endDef2: Dict[str, Any] | None = None, propagateTags: str = 'ONE_TO_TWO', relationshipCategory: str = 'AGGREGATION', relationshipLabel: str = '__SalesforceOrganization.reports', serviceType: str | None = None)[source]
class pyatlan.model.typedef.TypeDefResponse(*, enumDefs: List[EnumDef] = None, structDefs: List[StructDef] = None, classificationDefs: List[AtlanTagDef] = None, entityDefs: List[EntityDef] = None, relationshipDefs: List[RelationshipDef] = None, businessMetadataDefs: List[CustomMetadataDef] = None)[source]