Core model

class pyatlan.model.core.AtlanTagName(*args, **kwargs)

classmethod get_deleted_sentinel() → AtlanTagName

Will return an AtlanTagName that is a sentinel object to represent deleted tags.

class pyatlan.model.core.AtlanTag(*, typeName: AtlanTagName | None = None, entityGuid: str | None = None, entityStatus: EntityStatus | None = None, propagate: bool | None = False, removePropagationsOnEntityDelete: bool | None = True, restrictPropagationThroughLineage: bool | None = False, restrictPropagationThroughHierarchy: bool | None = False, validityPeriods: List[str] | None = None, sourceTagAttachments: List[SourceTagAttachment] = None, attributes: Dict[str, Any] | None = None, tagId: str | None = None)

classmethod of(atlan_tag_name: AtlanTagName, entity_guid: str | None = None, source_tag_attachment: SourceTagAttachment | None = None, client: AtlanClient | None = None) → AtlanTag

Construct an Atlan tag assignment for a specific entity.

Parameters:

• atlan_tag_name – human-readable name of the Atlan tag

• entity_guid – unique identifier (GUID) of the entity to which the Atlan tag is to be assigned

• source_tag_attachment – (optional) source-specific details for the tag

• client – (optional) client instance used for translating source-specific details

Returns:

an Atlan tag assignment with default settings for propagation and a specific entity assignment

Raises:

InvalidRequestError – if client is not provided and source_tag_attachment is specified

class pyatlan.model.core.AtlanTags(*, __root__: List[AtlanTag] = None)

class pyatlan.model.core.Announcement(announcement_title: 'str', announcement_type: 'AnnouncementType', announcement_message: 'Optional[str]' = FieldInfo(extra={}))

class pyatlan.model.core.AssetRequest(*, entity: T = None)

class pyatlan.model.core.AssetResponse(*, entity: T = None, referredentities: Dict[str, Any] | None = None)

class pyatlan.model.core.BulkRequest(*, entities: List[T])

class pyatlan.model.core.SearchRequest(*, attributes: List[str] | None = None, offset: int | None = None, size: int | None = None)