Application

class datarobot.Application

An entity associated with a DataRobot Application.

Variables:

  • id (str) – The ID of the created application.

  • application_type_id (str) – The ID of the type of the application.

  • user_id (str) – The ID of the user which created the application.

  • model_deployment_id (str) – The ID of the associated model deployment.

  • deactivation_status_id (str or None) – The ID of the status object to track the asynchronous app deactivation process status. Will be None if the app was never deactivated.

  • name (str) – The name of the application.

  • created_by (str) – The username of the user created the application.

  • created_at (str) – The timestamp when the application was created.

  • updated_at (str) – The timestamp when the application was updated.

  • datasets (List[str]) – The list of datasets IDs associated with the application.

  • creator_first_name (Optional[str]) – Application creator first name. Optional.

  • creator_last_name (Optional[str]) – Application creator last name. Optional.

  • creator_userhash (Optional[str]) – Application creator userhash. Optional.

  • deployment_status_id (str) – The ID of the status object to track the asynchronous deployment process status.

  • description (str) – A description of the application.

  • cloud_provider (str) – The host of this application.

  • deployments (Optional[List[ApplicationDeployment]]) – A list of deployment details. Optional.

  • deployment_ids (List[str]) – A list of deployment IDs for this app.

  • deployment_name (Optional[str]) – Name of the deployment. Optional.

  • application_template_type (Optional[str]) – Application template type, purpose. Optional.

  • pool_used (bool) – Whether the pool where used for last app deployment.

  • permissions (List[str]) – The list of permitted actions, which the authenticated user can perform on this application. Permissions should be ApplicationPermission options.

  • has_custom_logo (bool) – Whether the app has a custom logo.

  • related_entities (Optional[ApplcationRelatedEntity]) – IDs of entities, related to app for easy search.

  • org_id (str) – ID of the app’s organization.

classmethod list(offset=None, limit=None, use_cases=None)

Retrieve a list of user applications.

Parameters:

  • offset (Optional[int]) – Optional. Retrieve applications in a list after this number.

  • limit (Optional[int]) – Optional. Retrieve only this number of applications.

  • use_cases (Optional[Union[UseCase, List[UseCase], str, List[str]]]) – Optional. Filter available Applications by a specific Use Case or Use Cases. Accepts either the entity or the ID. If set to [None], the method filters the application’s datasets by those not linked to a UseCase.

Returns:

applications – The requested list of user applications.

Return type:

List[Application]

classmethod get(application_id)

Retrieve a single application.

Parameters:

application_id (str) – The ID of the application to retrieve.

Returns:

application – The requested application.

Return type:

Application