GroupCache

class pyatlan.cache.group_cache.GroupCache(client: AtlanClient)

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

get_id_for_alias(alias: str) → str | None

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

get_id_for_name(name: str) → str | None

Translate the provided internal group name to its GUID.

Parameters:

name – human-readable name of the group

Returns:

unique identifier (GUID) of the group

get_name_for_id(idstr: str) → str | None

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

validate_aliases(aliases: Iterable[str])

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