Webapps#

class dataikuapi.dss.webapp.DSSWebApp(client, project_key, webapp_id)#

A handle for the webapp.

Important

Do not instantiate this class directly, instead use dataikuapi.dss.project.DSSProject.list_webapps().

get_state()#
Returns:

A wrapper object holding the webapp backend state.

Return type:

dataikuapi.dss.webapp.DSSWebAppBackendState

stop_backend()#

Stop the webapp backend.

start_or_restart_backend()#

Start or restart the webapp backend.

Returns:

A future tracking the restart progress.

Return type:

dataikuapi.dss.future.DSSFuture

get_settings()#
Returns:

A handle for the webapp settings.

Return type:

dataikuapi.dss.webapp.DSSWebAppSettings

get_backend_client()#
class dataikuapi.dss.webapp.DSSWebAppBackendClient(client, webapp)#

A client to interact by API with a standard webapp backend

property base_url#
property session#
url_for_path(path)#
class dataikuapi.dss.webapp.DSSWebAppBackendState(webapp_id, state)#

A wrapper object holding the webapp backend state.

Important

Do not instantiate this class directly, instead use dataikuapi.dss.webapp.DSSWebApp.get_state().

property state#
Returns:

The webapp backend state as a dict containing the keys:

Return type:

python dict

property running#
Returns:

Is the backend of the webapp currently running.

Return type:

bool

class dataikuapi.dss.webapp.DSSWebAppSettings(client, webapp, data)#

A handle for the webapp settings.

Important

Do not instantiate this class directly, instead use dataikuapi.dss.webapp.DSSWebApp.get_settings().

get_raw()#
Returns:

The webapp settings as a dict containing among other keys:

  • id: the webapp id,

  • name: the webapp name,

  • type: the webapp type (e.g. “STANDARD”),

  • projectKey: the related project key,

  • params: a dict containing other information depending on the webapp type such as the source code.

Return type:

python dict

save()#

Save the current webapp settings.

class dataikuapi.dss.webapp.DSSWebAppListItem(client, data)#

An item in a list of webapps.

Important

Do not instantiate this class directly, instead use dataikuapi.dss.project.DSSProject.list_webapps().

to_webapp()#

Convert the current item.

Returns:

A handle for the webapp.

Return type:

dataikuapi.dss.webapp.DSSWebApp

property id#
Returns:

The id of the webapp.

Return type:

string

property name#
Returns:

The name of the webapp.

Return type:

string