Workspaces

class dataikuapi.dss.workspace.DSSWorkspace(client, workspace_key)

A handle to interact with a workspace on the DSS instance.

Do not create this class directly, instead use dataikuapi.DSSClient.get_workspace()

get_settings()

Gets the settings of this workspace.

Returns:

a handle to read, modify and save the settings

Return type:

DSSWorkspaceSettings

list_objects()

List the objects in this workspace

Returns:

The list of the objects

Return type:

list of DSSWorkspaceObject

add_object(object)

Add an object to this workspace. Object can be of different shapes (dataikuapi.dss.dataset.DSSDataset, dataikuapi.dss.dataset.DSSDatasetListItem, dataikuapi.dss.wiki.DSSWikiArticle, dataikuapi.dss.app.DSSApp, DSSWorkspaceHtmlLinkObject, dataikuapi.dss.dashboard.DSSDashboard, dataikuapi.dss.dashboard.DSSDashboardListItem or a dict that contains the raw data)

delete()

Delete the workspace

This call requires Administrator rights on the workspace.

class dataikuapi.dss.workspace.DSSWorkspaceObject(workspace, data)

A handle on an object of a workspace

Do not create this class directly, instead use dataikuapi.dss.DSSWorkspace.list_objects()

get_raw()

remove()

Remove this object from the workspace

This call requires Contributor rights on the workspace.

class dataikuapi.dss.workspace.DSSWorkspaceSettings(workspace, settings)

A handle on the settings of a workspace

Do not create this class directly, instead use dataikuapi.dss.DSSWorkspace.get_settings()

get_raw()

property display_name

Get or set the name of the workspace

Return type:

str

property color

Get or set the background color of the workspace (using #xxxxxx syntax)

Return type:

str

property description

Get or set the description of the workspace

Return type:

str

property permissions

Get or set the permissions controlling who is a member, contributor or admin of the workspace

If user is not workspace admin, the permissions field is redacted to None.

Return type:

list of dict or None

save()

Save the changes made on the settings

This call requires Administrator rights on the workspace.

class dataikuapi.dss.workspace.DSSWorkspacePermissionItem

classmethod admin_group(group)

classmethod contributor_group(group)

classmethod member_group(group)

classmethod admin_user(user)

classmethod contributor_user(user)

classmethod member_user(user)