foundry_dev_tools.resources.folder module

foundry_dev_tools.resources.folder module#

Folder helper class.

class foundry_dev_tools.resources.folder.Folder[source]#

Bases: Resource

Not intended to be initialized directly. Use Resource.from_rid() or Resource.from_path() instead.

rid_start: ClassVar[str] = 'ri.compass.main.folder'#
get_child_objects(rid, filter=None, decoration=None, limit=None, sort=None, permissive_folders=None, include_operations=False, additional_operations=None)#

Returns children in a given compass folder (automatic pagination).

Parameters:

  • rid (api_types.Rid) – resource identifier

  • filter (set[str] | None) – filter out resources, syntax “service.instance.type”

  • decoration (api_types.ResourceDecorationSetAll | None) – extra information for the decorated resource

  • limit (int | None) – maximum items in a page

  • sort (str | None) – A space-delimited specifier of the form “[a][ b]” [a] can be “name”, “lastModified”, or “rid” [b] is optional and can be “asc” or “desc” (e.g. “rid asc”, “name”, “lastModified desc”)

  • permissive_folders (bool | None) – Allows folder access if any sub-resource is accessible, ignoring folder permissions Default is false, non-hidden folders only

  • include_operations (bool) – Controls inclusion of Compass GK operations Is set to false in Foundry DevTools to improve performance. Set to None for Foundry instance default

  • additional_operations (str | None) – Adds specific user-permitted operations to response. Requires include_perations=True

Return type:

Iterator[dict]

create_folder(name, marking_ids=None)[source]#

Wrapper around foundry_dev_tools.clients.compass.CompassClient.api_create_folder().

Parameters:
Return type:

Folder

Contents