pyapacheatlas.core.entity.AtlasEntity#

class pyapacheatlas.core.entity.AtlasEntity(name, typeName, qualified_name, guid=None, **kwargs)#

A python representation of the AtlasEntity from Apache Atlas.

Parameters

  • name (str) – The name of this instance of an atlas entity.

  • typeName (str) – The type this entity should be.

  • qualified_name (str) – The unique “qualified name” of this instance of an atlas entity.

  • guid (Union(str,int)) – The guid to reference this entity by. Should be a negative number if you’re adding an entity. Consider using get_guid() method from GuidTracker to retrieve unique negative numbers.

  • relationshipAttributes (dict, optional) – The relationship attributes representing how this entity is connected to others. Commonly used for “columns” to indicate entity is a column of a table or “query” to indicate a process entity is tied another process in a column lineage scenario.

  • attributes (dict, optional) – Additional attributes that your atlas entity may require.

  • classifications (dict, optional) – Classifications that may be applied to this atlas entity.

  • contacts (dict(str, dict(str, list(dict(strt,str)))), optional) – Contacts should contain keys Experts and/or Owners. Their values should be a list of dicts with keys id and info. Id is a microsoft graph object id. Info is a string of extra information.

__init__(name, typeName, qualified_name, guid=None, **kwargs)#

Methods

__init__(name, typeName, qualified_name[, guid])

addBusinessAttribute(**kwargs)

Add one or many businessAttributes to the entity.

addClassification(*args)

Add one or many classifications to the entity.

addCustomAttribute(**kwargs)

Add one or many customAttributes to the entity.

addRelationship(**kwargs)

Add one or many relationshipAttributes to the entity.

from_json(entity_json)

merge(other)

Update the calling object with the attributes and classifications of the passed in AtlasEntity.

to_json([minimum])

Convert this atlas entity to a dict / json.

Attributes

name

Retrieve the name of this entity.

qualifiedName

Retrieve the qualifiedName of this entity.