sdk.CatalogWorkspaceService

Properties

NameDescription
organization_idNone

Methods

NameDescription
add_metadata_locale (workspace_id: str, target_language: str, translator_func: Callable, set_locale: bool)Add and optionally set the metadata localization for a workspace in a target language.
add_title_description ()None
add_title_description_tags ()None
clean_metadata_localization (workspace_id: str, target_language: str)Clean the metadata localization for a workspace.
clone_workspace (source_workspace_id: str, target_workspace_id: str, target_workspace_name: str, overwrite_existing: bool, data_source_mapping: dict, upper_case: bool, place_in_hierarchy: bool)Clone workspace from existing workspace.
create_custom_workspace_folder ()None
create_or_update (workspace: CatalogWorkspace)Create a new workspace or overwrite an existing workspace with the same id.
create_or_update_filter_view (workspace_id: str, filter_view: CatalogFilterView)Create a new filter view or overwrite an existing one.
create_or_update_user_data_filter (workspace_id: str, user_data_filter: CatalogUserDataFilter)Create a new user data filter or overwrite an existing one.
create_or_update_workspace_setting (workspace_id: str, workspace_setting: CatalogWorkspaceSetting)Create a new workspace setting or overwrite an existing workspace setting with the same id.
delete_filter_view (workspace_id: str, filter_view_id: str)Delete filter view.
delete_user_data_filter (workspace_id: str, user_data_filter_id: str)Delete user data filter.
delete_workspace (workspace_id: str)Delete a workspace with all its content - logical model and analytics model.
delete_workspace_setting ()None
generate_localized_workspaces (workspace_id: <nil>, to_lang: <nil>, to_locale: <nil>, from_lang: <nil>, translator_func: <nil>, layout_root_path: <nil>, provision_workspace: <nil>, store_layouts: <nil>, place_in_hierarchy: bool)Generate layouts of new workspaces based on the source workspace.
get_declarative_automations (workspace_id: str)Retrieve a list of declarative automations.
get_declarative_filter_views (workspace_id: str)Retrieve a list of declarative filter views.
get_declarative_user_data_filters (workspace_id: str)Retrieve a user data filers layout.
get_declarative_workspace (workspace_id: str, exclude: Optional[list[str]])Retrieve a workspace layout.
get_declarative_workspace_data_filters ()Retrieve a workspace data filers layout.
get_declarative_workspaces (exclude: Optional[list[str]])Get all workspaces in the current organization in a declarative form.
get_filter_view (workspace_id: str, filter_view_id: str)Get filter view by its id.
get_metadata_localization (workspace_id: str, target_language: str)Retrieve the metadata localization for a workspace.
get_organization ()None
get_texts_to_translate ()None
get_user_data_filter (workspace_id: str, user_data_filter_id: str)Get user data filter by its id.
get_workspace (workspace_id: str)Get an individual workspace.
get_workspace_setting ()None
layout_organization_folder ()None
list_filters_views (workspace_id: str)list all filter views.
list_user_data_filters (workspace_id: str)list all user data filers.
list_workspace_settings ()None
list_workspaces ()Returns a list of all workspaces in current organization
load_and_put_declarative_filter_views (workspace_id: str, layout_root_path: Path)Loads and sets the layouts stored using store_declarative_filter_views.
load_and_put_declarative_user_data_filters (workspace_id: str, layout_root_path: Path)Loads and sets the layouts stored using store_declarative_user_data_filters.
load_and_put_declarative_workspace (workspace_id: str, layout_root_path: Path)Loads and sets the layouts stored using store_declarative_workspace.
load_and_put_declarative_workspace_data_filters (layout_root_path: Path)Loads and sets the layouts stored using store_declarative_workspace_data_filters.
load_and_put_declarative_workspaces (layout_root_path: Path)Loads and sets the layouts stored using store_declarative_workspaces.
load_declarative_filter_views (layout_root_path: Path)Loads filter views layout, which was stored using store_declarative_filter_views.
load_declarative_user_data_filters (layout_root_path: Path)Loads user data filters layout, which was stored using store_declarative_user_data_filters.
load_declarative_workspace (workspace_id: str, layout_root_path: Path)Load declarative workspaces layout, which was stored using store_declarative_workspace.
load_declarative_workspace_data_filters (layout_root_path: Path)Loads workspace data filters layout, which was stored using store_declarative_workspace_data_filters.
load_declarative_workspaces (layout_root_path: Path)Load declarative workspaces layout, which was stored using store_declarative_workspaces
provision_workspace_with_locales ()None
put_declarative_automations (workspace_id: str, automations: list[CatalogDeclarativeAutomation])Set automations for the workspace.
put_declarative_filter_views (workspace_id: str, filter_views: list[CatalogDeclarativeFilterView])Set filter views for the workspace.
put_declarative_user_data_filters (workspace_id: str, user_data_filters: CatalogDeclarativeUserDataFilters)Set user data filters layout.
put_declarative_workspace (workspace_id: str, workspace: CatalogDeclarativeWorkspaceModel, standalone_copy: bool)Set a workspace layout.
put_declarative_workspace_data_filters (workspace_data_filters: CatalogDeclarativeWorkspaceDataFilters)Set workspace data filters layout.
put_declarative_workspaces (workspace: CatalogDeclarativeWorkspaces)Set layout of all workspaces and their hierarchy. Parameter is in declarative form.
read_translation_file ()None
resolve_all_workspace_settings ()None
resolve_workspace_settings ()None
save_metadata_locale_to_disk (workspace_id: str, target_language: str, file_path: Path)Save the metadata localization for a workspace to a file.
set_metadata_locale_from_disk (workspace_id: str, file_path: Path)Load and set the metadata localization for a workspace from a file.
set_metadata_localization (workspace_id: str, encoded_xml: bytes)Set the metadata localization for a workspace.
set_title_description ()None
set_title_description_tags ()None
set_translated_texts ()None
store_declarative_filter_views (workspace_id: str, layout_root_path: Path)Store filter views layout in a directory hierarchy.
store_declarative_user_data_filters (workspace_id: str, layout_root_path: Path)Store user data filters layout in a directory hierarchy.
store_declarative_workspace (workspace_id: str, layout_root_path: Path, exclude: Optional[list[str]])Store workspace layout in a directory hierarchy.
store_declarative_workspace_data_filters (layout_root_path: Path)Store workspace data filters layout in a directory hierarchy.
store_declarative_workspaces (layout_root_path: Path)Stores declarative workspaces in a given path, as folder hierarchy.
translate_if_requested ()None
translate_in_batches ()None