GroupCache#

class pyatlan.cache.group_cache.GroupCache(group_client: GroupClient)[source]#

Lazily-loaded cache for translating Atlan-internal groups into their various IDs.

classmethod get_id_for_alias(alias: str) str | None[source]#

Translate the provided human-readable group name to its GUID.

Parameters:

alias – name of the group as it appears in the UI

Returns:

unique identifier (GUID) of the group

classmethod get_id_for_name(name: str) str | None[source]#

Translate the provided internal group name to its GUID.

Parameters:

name – human-readable name of the group

Returns:

unique identifier (GUID) of the group

classmethod get_name_for_id(idstr: str) str | None[source]#

Translate the provided group GUID to the internal group name.

Parameters:

idstr – unique identifier (GUID) of the group

Returns:

human-readable name of the group

classmethod validate_aliases(aliases: Iterable[str])[source]#

Validate that the given (internal) group names are valid. A ValueError will be raised in any are not.

Parameters:

aliases – a collection of (internal) group names to be checked