pyapacheatlas.core.client.AtlasClient.get_entity#

AtlasClient.get_entity(guid=None, qualifiedName=None, typeName=None, ignoreRelationships=False, minExtInfo=False)#

Retrieve one or many guids from your Atlas backed Data Catalog.

Returns a dictionary with keys “referredEntities” and “entities”. You’ll want to grab the entities values which is a list of entities.

You can provide a single guid or a list of guids. You can provide a single typeName and multiple qualified names in a list.

Parameters

  • guid (Union(str, list(str))) – The guid or guids you want to retrieve. Not used if using typeName and qualifiedName.

  • qualifiedName (Union(str, list(str))) – The qualified name of the entity you want to find. Must provide typeName if using qualifiedName. You may search for multiple qualified names under the same type. Ignored if using guid parameter.

  • typeName (str) – The type name of the entity you want to find. Must provide qualifiedName if using typeName. Ignored if using guid parameter.

  • ignoreRelationships (bool) – Exclude the relationship information from the response.

  • minExtInfo (bool) – Exclude the extra information from the response.

Returns

An AtlasEntitiesWithExtInfo object which includes a list of entities and accessible with the “entities” key.

Return type

dict(str, Union(list(dict),dict))