pyapacheatlas.core.client.AtlasClient.get_typedef#
- AtlasClient.get_typedef(type_category=None, guid=None, name=None)#
Retrieve a single type def based on its guid, name, or type category and (guid or name). Rule of thumb: Use guid if you have it, use name if you want to essentially use duck typing and are testing what keys you’re reading from the response, or use type_category when you want to guarantee the type being returned.
- Parameters
type_category (
TypeCategory) – The type category your type def belongs to. You most likely want TypeCategory.ENTITY. Optional if name or guid is specified.guid (str,optional) – A valid guid. Optional if name is specified.
name (str,optional) – A valid name. Optional if guid is specified.
- Returns
A dictionary representing an Atlas{TypeCategory}Def.
- Return type
dict