Apps

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.apps module.

class databricks.sdk.service.apps.App(name: 'str', active_deployment: 'Optional[AppDeployment]' = None, app_status: 'Optional[ApplicationStatus]' = None, budget_policy_id: 'Optional[str]' = None, compute_max_instances: 'Optional[int]' = None, compute_min_instances: 'Optional[int]' = None, compute_size: 'Optional[ComputeSize]' = None, compute_status: 'Optional[ComputeStatus]' = None, create_time: 'Optional[str]' = None, creator: 'Optional[str]' = None, default_source_code_path: 'Optional[str]' = None, description: 'Optional[str]' = None, effective_budget_policy_id: 'Optional[str]' = None, effective_usage_policy_id: 'Optional[str]' = None, effective_user_api_scopes: 'Optional[List[str]]' = None, git_repository: 'Optional[GitRepository]' = None, id: 'Optional[str]' = None, oauth2_app_client_id: 'Optional[str]' = None, oauth2_app_integration_id: 'Optional[str]' = None, pending_deployment: 'Optional[AppDeployment]' = None, resources: 'Optional[List[AppResource]]' = None, service_principal_client_id: 'Optional[str]' = None, service_principal_id: 'Optional[int]' = None, service_principal_name: 'Optional[str]' = None, space: 'Optional[str]' = None, telemetry_export_destinations: 'Optional[List[TelemetryExportDestination]]' = None, thumbnail_url: 'Optional[str]' = None, update_time: 'Optional[str]' = None, updater: 'Optional[str]' = None, url: 'Optional[str]' = None, usage_policy_id: 'Optional[str]' = None, user_api_scopes: 'Optional[List[str]]' = None)

name: str

The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.

active_deployment: AppDeployment | None = None

The active deployment of the app. A deployment is considered active when it has been deployed to the app compute.

app_status: ApplicationStatus | None = None

budget_policy_id: str | None = None

compute_max_instances: int | None = None

Maximum number of app instances. Must be set together with compute_min_instances.

compute_min_instances: int | None = None

Minimum number of app instances. Must be set together with compute_max_instances.

compute_size: ComputeSize | None = None

compute_status: ComputeStatus | None = None

create_time: str | None = None

The creation time of the app. Formatted timestamp in ISO 6801.

creator: str | None = None

The email of the user that created the app.

default_source_code_path: str | None = None

The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.

description: str | None = None

The description of the app.

effective_budget_policy_id: str | None = None

effective_usage_policy_id: str | None = None

effective_user_api_scopes: List[str] | None = None

The effective api scopes granted to the user access token.

git_repository: GitRepository | None = None

Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).

id: str | None = None

The unique identifier of the app.

oauth2_app_client_id: str | None = None

oauth2_app_integration_id: str | None = None

pending_deployment: AppDeployment | None = None

The pending deployment of the app. A deployment is considered pending when it is being prepared for deployment to the app compute.

resources: List[AppResource] | None = None

Resources for the app.

service_principal_client_id: str | None = None

service_principal_id: int | None = None

service_principal_name: str | None = None

space: str | None = None

Name of the space this app belongs to.

telemetry_export_destinations: List[TelemetryExportDestination] | None = None

thumbnail_url: str | None = None

The URL of the thumbnail image for the app.

update_time: str | None = None

The update time of the app. Formatted timestamp in ISO 6801.

updater: str | None = None

The email of the user that last updated the app.

url: str | None = None

The URL of the app once it is deployed.

usage_policy_id: str | None = None

user_api_scopes: List[str] | None = None

as_dict() → dict

Serializes the App into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the App into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → App

Deserializes the App from a dictionary.

class databricks.sdk.service.apps.AppAccessControlRequest(group_name: 'Optional[str]' = None, permission_level: 'Optional[AppPermissionLevel]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

group_name: str | None = None

name of the group

permission_level: AppPermissionLevel | None = None

service_principal_name: str | None = None

application ID of a service principal

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the AppAccessControlRequest into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppAccessControlRequest into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppAccessControlRequest

Deserializes the AppAccessControlRequest from a dictionary.

class databricks.sdk.service.apps.AppAccessControlResponse(all_permissions: 'Optional[List[AppPermission]]' = None, display_name: 'Optional[str]' = None, group_name: 'Optional[str]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

all_permissions: List[AppPermission] | None = None

All permissions.

display_name: str | None = None

Display name of the user or service principal.

group_name: str | None = None

name of the group

service_principal_name: str | None = None

Name of the service principal.

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the AppAccessControlResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppAccessControlResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppAccessControlResponse

Deserializes the AppAccessControlResponse from a dictionary.

class databricks.sdk.service.apps.AppDeployment(command: 'Optional[List[str]]' = None, create_time: 'Optional[str]' = None, creator: 'Optional[str]' = None, deployment_artifacts: 'Optional[AppDeploymentArtifacts]' = None, deployment_id: 'Optional[str]' = None, env_vars: 'Optional[List[EnvVar]]' = None, git_source: 'Optional[GitSource]' = None, mode: 'Optional[AppDeploymentMode]' = None, source_code_path: 'Optional[str]' = None, status: 'Optional[AppDeploymentStatus]' = None, update_time: 'Optional[str]' = None)

command: List[str] | None = None

The command with which to run the app. This will override the command specified in the app.yaml file.

create_time: str | None = None

The creation time of the deployment. Formatted timestamp in ISO 6801.

creator: str | None = None

The email of the user creates the deployment.

deployment_artifacts: AppDeploymentArtifacts | None = None

The deployment artifacts for an app.

deployment_id: str | None = None

The unique id of the deployment.

env_vars: List[EnvVar] | None = None

The environment variables to set in the app runtime environment. This will override the environment variables specified in the app.yaml file.

git_source: GitSource | None = None

Git repository to use as the source for the app deployment.

mode: AppDeploymentMode | None = None

The mode of which the deployment will manage the source code.

source_code_path: str | None = None

The workspace file system path of the source code used to create the app deployment. This is different from deployment_artifacts.source_code_path, which is the path used by the deployed app. The former refers to the original source code location of the app in the workspace during deployment creation, whereas the latter provides a system generated stable snapshotted source code path used by the deployment.

status: AppDeploymentStatus | None = None

Status and status message of the deployment

update_time: str | None = None

The update time of the deployment. Formatted timestamp in ISO 6801.

as_dict() → dict

Serializes the AppDeployment into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppDeployment into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppDeployment

Deserializes the AppDeployment from a dictionary.

class databricks.sdk.service.apps.AppDeploymentArtifacts(source_code_path: 'Optional[str]' = None)

source_code_path: str | None = None

The snapshotted workspace file system path of the source code loaded by the deployed app.

as_dict() → dict

Serializes the AppDeploymentArtifacts into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppDeploymentArtifacts into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppDeploymentArtifacts

Deserializes the AppDeploymentArtifacts from a dictionary.

class databricks.sdk.service.apps.AppDeploymentMode

AUTO_SYNC = "AUTO_SYNC"

SNAPSHOT = "SNAPSHOT"

class databricks.sdk.service.apps.AppDeploymentState

CANCELLED = "CANCELLED"

FAILED = "FAILED"

IN_PROGRESS = "IN_PROGRESS"

SUCCEEDED = "SUCCEEDED"

class databricks.sdk.service.apps.AppDeploymentStatus(message: 'Optional[str]' = None, state: 'Optional[AppDeploymentState]' = None)

message: str | None = None

Message corresponding with the deployment state.

state: AppDeploymentState | None = None

State of the deployment.

as_dict() → dict

Serializes the AppDeploymentStatus into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppDeploymentStatus into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppDeploymentStatus

Deserializes the AppDeploymentStatus from a dictionary.

class databricks.sdk.service.apps.AppManifest(version: int, name: str, description: str | None = None, resource_specs: List[AppManifestAppResourceSpec] | None = None)

App manifest definition

version: int

The manifest schema version, for now only 1 is allowed

name: str

Name of the app defined by manifest author / publisher

description: str | None = None

Description of the app defined by manifest author / publisher

resource_specs: List[AppManifestAppResourceSpec] | None = None

as_dict() → dict

Serializes the AppManifest into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifest into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifest

Deserializes the AppManifest from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceExperimentSpec(permission: 'AppManifestAppResourceExperimentSpecExperimentPermission')

permission: AppManifestAppResourceExperimentSpecExperimentPermission

as_dict() → dict

Serializes the AppManifestAppResourceExperimentSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceExperimentSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceExperimentSpec

Deserializes the AppManifestAppResourceExperimentSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceExperimentSpecExperimentPermission

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_READ = "CAN_READ"

class databricks.sdk.service.apps.AppManifestAppResourceJobSpec(permission: 'AppManifestAppResourceJobSpecJobPermission')

permission: AppManifestAppResourceJobSpecJobPermission

Permissions to grant on the Job. Supported permissions are: “CAN_MANAGE”, “IS_OWNER”, “CAN_MANAGE_RUN”, “CAN_VIEW”.

as_dict() → dict

Serializes the AppManifestAppResourceJobSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceJobSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceJobSpec

Deserializes the AppManifestAppResourceJobSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceJobSpecJobPermission

CAN_MANAGE = "CAN_MANAGE"

CAN_MANAGE_RUN = "CAN_MANAGE_RUN"

CAN_VIEW = "CAN_VIEW"

IS_OWNER = "IS_OWNER"

class databricks.sdk.service.apps.AppManifestAppResourceSecretSpec(permission: 'AppManifestAppResourceSecretSpecSecretPermission')

permission: AppManifestAppResourceSecretSpecSecretPermission

Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: “READ”, “WRITE”, “MANAGE”.

as_dict() → dict

Serializes the AppManifestAppResourceSecretSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceSecretSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceSecretSpec

Deserializes the AppManifestAppResourceSecretSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceSecretSpecSecretPermission

Permission to grant on the secret scope. Supported permissions are: “READ”, “WRITE”, “MANAGE”.

MANAGE = "MANAGE"

READ = "READ"

WRITE = "WRITE"

class databricks.sdk.service.apps.AppManifestAppResourceServingEndpointSpec(permission: 'AppManifestAppResourceServingEndpointSpecServingEndpointPermission')

permission: AppManifestAppResourceServingEndpointSpecServingEndpointPermission

Permission to grant on the serving endpoint. Supported permissions are: “CAN_MANAGE”, “CAN_QUERY”, “CAN_VIEW”.

as_dict() → dict

Serializes the AppManifestAppResourceServingEndpointSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceServingEndpointSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceServingEndpointSpec

Deserializes the AppManifestAppResourceServingEndpointSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceServingEndpointSpecServingEndpointPermission

CAN_MANAGE = "CAN_MANAGE"

CAN_QUERY = "CAN_QUERY"

CAN_VIEW = "CAN_VIEW"

class databricks.sdk.service.apps.AppManifestAppResourceSpec(name: str, description: str | None = None, experiment_spec: AppManifestAppResourceExperimentSpec | None = None, job_spec: AppManifestAppResourceJobSpec | None = None, secret_spec: AppManifestAppResourceSecretSpec | None = None, serving_endpoint_spec: AppManifestAppResourceServingEndpointSpec | None = None, sql_warehouse_spec: AppManifestAppResourceSqlWarehouseSpec | None = None, uc_securable_spec: AppManifestAppResourceUcSecurableSpec | None = None)

AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. name, id, key, scope, etc.)

name: str

Name of the App Resource.

description: str | None = None

Description of the App Resource.

experiment_spec: AppManifestAppResourceExperimentSpec | None = None

job_spec: AppManifestAppResourceJobSpec | None = None

secret_spec: AppManifestAppResourceSecretSpec | None = None

serving_endpoint_spec: AppManifestAppResourceServingEndpointSpec | None = None

sql_warehouse_spec: AppManifestAppResourceSqlWarehouseSpec | None = None

uc_securable_spec: AppManifestAppResourceUcSecurableSpec | None = None

as_dict() → dict

Serializes the AppManifestAppResourceSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceSpec

Deserializes the AppManifestAppResourceSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceSqlWarehouseSpec(permission: 'AppManifestAppResourceSqlWarehouseSpecSqlWarehousePermission')

permission: AppManifestAppResourceSqlWarehouseSpecSqlWarehousePermission

Permission to grant on the SQL warehouse. Supported permissions are: “CAN_MANAGE”, “CAN_USE”, “IS_OWNER”.

as_dict() → dict

Serializes the AppManifestAppResourceSqlWarehouseSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceSqlWarehouseSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceSqlWarehouseSpec

Deserializes the AppManifestAppResourceSqlWarehouseSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceSqlWarehouseSpecSqlWarehousePermission

CAN_MANAGE = "CAN_MANAGE"

CAN_USE = "CAN_USE"

IS_OWNER = "IS_OWNER"

class databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpec(securable_type: 'AppManifestAppResourceUcSecurableSpecUcSecurableType', permission: 'AppManifestAppResourceUcSecurableSpecUcSecurablePermission')

securable_type: AppManifestAppResourceUcSecurableSpecUcSecurableType

permission: AppManifestAppResourceUcSecurableSpecUcSecurablePermission

as_dict() → dict

Serializes the AppManifestAppResourceUcSecurableSpec into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppManifestAppResourceUcSecurableSpec into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppManifestAppResourceUcSecurableSpec

Deserializes the AppManifestAppResourceUcSecurableSpec from a dictionary.

class databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission

EXECUTE = "EXECUTE"

MANAGE = "MANAGE"

READ_VOLUME = "READ_VOLUME"

SELECT = "SELECT"

USE_CONNECTION = "USE_CONNECTION"

WRITE_VOLUME = "WRITE_VOLUME"

class databricks.sdk.service.apps.AppManifestAppResourceUcSecurableSpecUcSecurableType

CONNECTION = "CONNECTION"

FUNCTION = "FUNCTION"

TABLE = "TABLE"

VOLUME = "VOLUME"

class databricks.sdk.service.apps.AppPermission(inherited: 'Optional[bool]' = None, inherited_from_object: 'Optional[List[str]]' = None, permission_level: 'Optional[AppPermissionLevel]' = None)

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: AppPermissionLevel | None = None

as_dict() → dict

Serializes the AppPermission into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppPermission into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppPermission

Deserializes the AppPermission from a dictionary.

class databricks.sdk.service.apps.AppPermissionLevel

Permission level

CAN_MANAGE = "CAN_MANAGE"

CAN_USE = "CAN_USE"

class databricks.sdk.service.apps.AppPermissions(access_control_list: 'Optional[List[AppAccessControlResponse]]' = None, object_id: 'Optional[str]' = None, object_type: 'Optional[str]' = None)

access_control_list: List[AppAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

Serializes the AppPermissions into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppPermissions into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppPermissions

Deserializes the AppPermissions from a dictionary.

class databricks.sdk.service.apps.AppPermissionsDescription(description: 'Optional[str]' = None, permission_level: 'Optional[AppPermissionLevel]' = None)

description: str | None = None

permission_level: AppPermissionLevel | None = None

as_dict() → dict

Serializes the AppPermissionsDescription into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppPermissionsDescription into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppPermissionsDescription

Deserializes the AppPermissionsDescription from a dictionary.

class databricks.sdk.service.apps.AppResource(name: 'str', app: 'Optional[AppResourceApp]' = None, database: 'Optional[AppResourceDatabase]' = None, description: 'Optional[str]' = None, experiment: 'Optional[AppResourceExperiment]' = None, genie_space: 'Optional[AppResourceGenieSpace]' = None, job: 'Optional[AppResourceJob]' = None, postgres: 'Optional[AppResourcePostgres]' = None, secret: 'Optional[AppResourceSecret]' = None, serving_endpoint: 'Optional[AppResourceServingEndpoint]' = None, sql_warehouse: 'Optional[AppResourceSqlWarehouse]' = None, uc_securable: 'Optional[AppResourceUcSecurable]' = None)

name: str

Name of the App Resource.

app: AppResourceApp | None = None

database: AppResourceDatabase | None = None

description: str | None = None

Description of the App Resource.

experiment: AppResourceExperiment | None = None

genie_space: AppResourceGenieSpace | None = None

job: AppResourceJob | None = None

postgres: AppResourcePostgres | None = None

secret: AppResourceSecret | None = None

serving_endpoint: AppResourceServingEndpoint | None = None

sql_warehouse: AppResourceSqlWarehouse | None = None

uc_securable: AppResourceUcSecurable | None = None

as_dict() → dict

Serializes the AppResource into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResource into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResource

Deserializes the AppResource from a dictionary.

class databricks.sdk.service.apps.AppResourceApp(name: 'Optional[str]' = None, permission: 'Optional[AppResourceAppAppPermission]' = None)

name: str | None = None

permission: AppResourceAppAppPermission | None = None

as_dict() → dict

Serializes the AppResourceApp into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceApp into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceApp

Deserializes the AppResourceApp from a dictionary.

class databricks.sdk.service.apps.AppResourceAppAppPermission

CAN_USE = "CAN_USE"

class databricks.sdk.service.apps.AppResourceDatabase(instance_name: 'str', database_name: 'str', permission: 'AppResourceDatabaseDatabasePermission')

instance_name: str

database_name: str

permission: AppResourceDatabaseDatabasePermission

as_dict() → dict

Serializes the AppResourceDatabase into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceDatabase into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceDatabase

Deserializes the AppResourceDatabase from a dictionary.

class databricks.sdk.service.apps.AppResourceDatabaseDatabasePermission

CAN_CONNECT_AND_CREATE = "CAN_CONNECT_AND_CREATE"

class databricks.sdk.service.apps.AppResourceExperiment(experiment_id: 'str', permission: 'AppResourceExperimentExperimentPermission')

experiment_id: str

permission: AppResourceExperimentExperimentPermission

as_dict() → dict

Serializes the AppResourceExperiment into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceExperiment into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceExperiment

Deserializes the AppResourceExperiment from a dictionary.

class databricks.sdk.service.apps.AppResourceExperimentExperimentPermission

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_READ = "CAN_READ"

class databricks.sdk.service.apps.AppResourceGenieSpace(name: 'str', space_id: 'str', permission: 'AppResourceGenieSpaceGenieSpacePermission')

name: str

space_id: str

permission: AppResourceGenieSpaceGenieSpacePermission

as_dict() → dict

Serializes the AppResourceGenieSpace into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceGenieSpace into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceGenieSpace

Deserializes the AppResourceGenieSpace from a dictionary.

class databricks.sdk.service.apps.AppResourceGenieSpaceGenieSpacePermission

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_RUN = "CAN_RUN"

CAN_VIEW = "CAN_VIEW"

class databricks.sdk.service.apps.AppResourceJob(id: 'str', permission: 'AppResourceJobJobPermission')

id: str

Id of the job to grant permission on.

permission: AppResourceJobJobPermission

Permissions to grant on the Job. Supported permissions are: “CAN_MANAGE”, “IS_OWNER”, “CAN_MANAGE_RUN”, “CAN_VIEW”.

as_dict() → dict

Serializes the AppResourceJob into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceJob into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceJob

Deserializes the AppResourceJob from a dictionary.

class databricks.sdk.service.apps.AppResourceJobJobPermission

CAN_MANAGE = "CAN_MANAGE"

CAN_MANAGE_RUN = "CAN_MANAGE_RUN"

CAN_VIEW = "CAN_VIEW"

IS_OWNER = "IS_OWNER"

class databricks.sdk.service.apps.AppResourcePostgres(branch: 'Optional[str]' = None, database: 'Optional[str]' = None, permission: 'Optional[AppResourcePostgresPostgresPermission]' = None)

branch: str | None = None

database: str | None = None

permission: AppResourcePostgresPostgresPermission | None = None

as_dict() → dict

Serializes the AppResourcePostgres into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourcePostgres into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourcePostgres

Deserializes the AppResourcePostgres from a dictionary.

class databricks.sdk.service.apps.AppResourcePostgresPostgresPermission

CAN_CONNECT_AND_CREATE = "CAN_CONNECT_AND_CREATE"

class databricks.sdk.service.apps.AppResourceSecret(scope: 'str', key: 'str', permission: 'AppResourceSecretSecretPermission')

scope: str

Scope of the secret to grant permission on.

key: str

Key of the secret to grant permission on.

permission: AppResourceSecretSecretPermission

Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: “READ”, “WRITE”, “MANAGE”.

as_dict() → dict

Serializes the AppResourceSecret into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceSecret into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceSecret

Deserializes the AppResourceSecret from a dictionary.

class databricks.sdk.service.apps.AppResourceSecretSecretPermission

Permission to grant on the secret scope. Supported permissions are: “READ”, “WRITE”, “MANAGE”.

MANAGE = "MANAGE"

READ = "READ"

WRITE = "WRITE"

class databricks.sdk.service.apps.AppResourceServingEndpoint(name: 'str', permission: 'AppResourceServingEndpointServingEndpointPermission')

name: str

Name of the serving endpoint to grant permission on.

permission: AppResourceServingEndpointServingEndpointPermission

Permission to grant on the serving endpoint. Supported permissions are: “CAN_MANAGE”, “CAN_QUERY”, “CAN_VIEW”.

as_dict() → dict

Serializes the AppResourceServingEndpoint into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceServingEndpoint into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceServingEndpoint

Deserializes the AppResourceServingEndpoint from a dictionary.

class databricks.sdk.service.apps.AppResourceServingEndpointServingEndpointPermission

CAN_MANAGE = "CAN_MANAGE"

CAN_QUERY = "CAN_QUERY"

CAN_VIEW = "CAN_VIEW"

class databricks.sdk.service.apps.AppResourceSqlWarehouse(id: 'str', permission: 'AppResourceSqlWarehouseSqlWarehousePermission')

id: str

Id of the SQL warehouse to grant permission on.

permission: AppResourceSqlWarehouseSqlWarehousePermission

Permission to grant on the SQL warehouse. Supported permissions are: “CAN_MANAGE”, “CAN_USE”, “IS_OWNER”.

as_dict() → dict

Serializes the AppResourceSqlWarehouse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceSqlWarehouse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceSqlWarehouse

Deserializes the AppResourceSqlWarehouse from a dictionary.

class databricks.sdk.service.apps.AppResourceSqlWarehouseSqlWarehousePermission

CAN_MANAGE = "CAN_MANAGE"

CAN_USE = "CAN_USE"

IS_OWNER = "IS_OWNER"

class databricks.sdk.service.apps.AppResourceUcSecurable(securable_full_name: 'str', securable_type: 'AppResourceUcSecurableUcSecurableType', permission: 'AppResourceUcSecurableUcSecurablePermission', securable_kind: 'Optional[str]' = None)

securable_full_name: str

securable_type: AppResourceUcSecurableUcSecurableType

permission: AppResourceUcSecurableUcSecurablePermission

securable_kind: str | None = None

The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind.

as_dict() → dict

Serializes the AppResourceUcSecurable into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppResourceUcSecurable into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppResourceUcSecurable

Deserializes the AppResourceUcSecurable from a dictionary.

class databricks.sdk.service.apps.AppResourceUcSecurableUcSecurablePermission

EXECUTE = "EXECUTE"

MODIFY = "MODIFY"

READ_VOLUME = "READ_VOLUME"

SELECT = "SELECT"

USE_CONNECTION = "USE_CONNECTION"

WRITE_VOLUME = "WRITE_VOLUME"

class databricks.sdk.service.apps.AppResourceUcSecurableUcSecurableType

CONNECTION = "CONNECTION"

FUNCTION = "FUNCTION"

TABLE = "TABLE"

VOLUME = "VOLUME"

class databricks.sdk.service.apps.AppThumbnail(thumbnail: str | None = None)

The thumbnail for an app.

thumbnail: str | None = None

The thumbnail image bytes.

as_dict() → dict

Serializes the AppThumbnail into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppThumbnail into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppThumbnail

Deserializes the AppThumbnail from a dictionary.

class databricks.sdk.service.apps.AppUpdate(budget_policy_id: 'Optional[str]' = None, compute_max_instances: 'Optional[int]' = None, compute_min_instances: 'Optional[int]' = None, compute_size: 'Optional[ComputeSize]' = None, description: 'Optional[str]' = None, git_repository: 'Optional[GitRepository]' = None, resources: 'Optional[List[AppResource]]' = None, status: 'Optional[AppUpdateUpdateStatus]' = None, usage_policy_id: 'Optional[str]' = None, user_api_scopes: 'Optional[List[str]]' = None)

budget_policy_id: str | None = None

compute_max_instances: int | None = None

Maximum number of app instances. Must be set together with compute_min_instances.

compute_min_instances: int | None = None

Minimum number of app instances. Must be set together with compute_max_instances.

compute_size: ComputeSize | None = None

description: str | None = None

git_repository: GitRepository | None = None

resources: List[AppResource] | None = None

status: AppUpdateUpdateStatus | None = None

usage_policy_id: str | None = None

user_api_scopes: List[str] | None = None

as_dict() → dict

Serializes the AppUpdate into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppUpdate into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppUpdate

Deserializes the AppUpdate from a dictionary.

class databricks.sdk.service.apps.AppUpdateUpdateStatus(message: 'Optional[str]' = None, state: 'Optional[AppUpdateUpdateStatusUpdateState]' = None)

message: str | None = None

state: AppUpdateUpdateStatusUpdateState | None = None

as_dict() → dict

Serializes the AppUpdateUpdateStatus into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AppUpdateUpdateStatus into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AppUpdateUpdateStatus

Deserializes the AppUpdateUpdateStatus from a dictionary.

class databricks.sdk.service.apps.AppUpdateUpdateStatusUpdateState

FAILED = "FAILED"

IN_PROGRESS = "IN_PROGRESS"

NOT_UPDATED = "NOT_UPDATED"

SUCCEEDED = "SUCCEEDED"

class databricks.sdk.service.apps.ApplicationState

CRASHED = "CRASHED"

DEPLOYING = "DEPLOYING"

RUNNING = "RUNNING"

UNAVAILABLE = "UNAVAILABLE"

class databricks.sdk.service.apps.ApplicationStatus(message: 'Optional[str]' = None, running_instances: 'Optional[int]' = None, state: 'Optional[ApplicationState]' = None)

message: str | None = None

Application status message

running_instances: int | None = None

The number of running instances of this application.

state: ApplicationState | None = None

State of the application.

as_dict() → dict

Serializes the ApplicationStatus into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ApplicationStatus into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ApplicationStatus

Deserializes the ApplicationStatus from a dictionary.

class databricks.sdk.service.apps.ComputeSize

LARGE = "LARGE"

MEDIUM = "MEDIUM"

class databricks.sdk.service.apps.ComputeState

ACTIVE = "ACTIVE"

DELETING = "DELETING"

ERROR = "ERROR"

STARTING = "STARTING"

STOPPED = "STOPPED"

STOPPING = "STOPPING"

UPDATING = "UPDATING"

class databricks.sdk.service.apps.ComputeStatus(active_instances: 'Optional[int]' = None, message: 'Optional[str]' = None, state: 'Optional[ComputeState]' = None)

active_instances: int | None = None

The number of compute instances currently serving requests for this application. An instance is considered active if it is reachable and ready to handle requests.

message: str | None = None

Compute status message

state: ComputeState | None = None

State of the app compute.

as_dict() → dict

Serializes the ComputeStatus into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ComputeStatus into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ComputeStatus

Deserializes the ComputeStatus from a dictionary.

class databricks.sdk.service.apps.CustomTemplate(name: 'str', git_repo: 'str', path: 'str', manifest: 'AppManifest', git_provider: 'str', creator: 'Optional[str]' = None, description: 'Optional[str]' = None)

name: str

The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace.

git_repo: str

The Git repository URL that the template resides in.

path: str

The path to the template within the Git repository.

manifest: AppManifest

The manifest of the template. It defines fields and default values when installing the template.

git_provider: str

The Git provider of the template.

creator: str | None = None

description: str | None = None

The description of the template.

as_dict() → dict

Serializes the CustomTemplate into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CustomTemplate into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CustomTemplate

Deserializes the CustomTemplate from a dictionary.

class databricks.sdk.service.apps.DatabricksServiceExceptionWithDetailsProto(details: List[dict] | None = None, error_code: ErrorCode | None = None, message: str | None = None, stack_trace: str | None = None)

Databricks Error that is returned by all Databricks APIs.

details: List[dict] | None = None

error_code: ErrorCode | None = None

message: str | None = None

stack_trace: str | None = None

as_dict() → dict

Serializes the DatabricksServiceExceptionWithDetailsProto into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DatabricksServiceExceptionWithDetailsProto into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DatabricksServiceExceptionWithDetailsProto

Deserializes the DatabricksServiceExceptionWithDetailsProto from a dictionary.

class databricks.sdk.service.apps.EnvVar(name: 'Optional[str]' = None, value: 'Optional[str]' = None, value_from: 'Optional[str]' = None)

name: str | None = None

The name of the environment variable.

value: str | None = None

The value for the environment variable.

value_from: str | None = None

The name of an external Databricks resource that contains the value, such as a secret or a database table.

as_dict() → dict

Serializes the EnvVar into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the EnvVar into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → EnvVar

Deserializes the EnvVar from a dictionary.

class databricks.sdk.service.apps.ErrorCode

Error codes returned by Databricks APIs to indicate specific failure conditions.

ABORTED = "ABORTED"

ALREADY_EXISTS = "ALREADY_EXISTS"

BAD_REQUEST = "BAD_REQUEST"

CANCELLED = "CANCELLED"

CATALOG_ALREADY_EXISTS = "CATALOG_ALREADY_EXISTS"

CATALOG_DOES_NOT_EXIST = "CATALOG_DOES_NOT_EXIST"

CATALOG_NOT_EMPTY = "CATALOG_NOT_EMPTY"

COULD_NOT_ACQUIRE_LOCK = "COULD_NOT_ACQUIRE_LOCK"

CUSTOMER_UNAUTHORIZED = "CUSTOMER_UNAUTHORIZED"

DAC_ALREADY_EXISTS = "DAC_ALREADY_EXISTS"

DAC_DOES_NOT_EXIST = "DAC_DOES_NOT_EXIST"

DATA_LOSS = "DATA_LOSS"

DEADLINE_EXCEEDED = "DEADLINE_EXCEEDED"

DEPLOYMENT_TIMEOUT = "DEPLOYMENT_TIMEOUT"

DIRECTORY_NOT_EMPTY = "DIRECTORY_NOT_EMPTY"

DIRECTORY_PROTECTED = "DIRECTORY_PROTECTED"

DRY_RUN_FAILED = "DRY_RUN_FAILED"

ENDPOINT_NOT_FOUND = "ENDPOINT_NOT_FOUND"

EXTERNAL_LOCATION_ALREADY_EXISTS = "EXTERNAL_LOCATION_ALREADY_EXISTS"

EXTERNAL_LOCATION_DOES_NOT_EXIST = "EXTERNAL_LOCATION_DOES_NOT_EXIST"

FEATURE_DISABLED = "FEATURE_DISABLED"

GIT_CONFLICT = "GIT_CONFLICT"

GIT_REMOTE_ERROR = "GIT_REMOTE_ERROR"

GIT_SENSITIVE_TOKEN_DETECTED = "GIT_SENSITIVE_TOKEN_DETECTED"

GIT_UNKNOWN_REF = "GIT_UNKNOWN_REF"

GIT_URL_NOT_ON_ALLOW_LIST = "GIT_URL_NOT_ON_ALLOW_LIST"

INSECURE_PARTNER_RESPONSE = "INSECURE_PARTNER_RESPONSE"

INTERNAL_ERROR = "INTERNAL_ERROR"

INVALID_PARAMETER_VALUE = "INVALID_PARAMETER_VALUE"

INVALID_STATE = "INVALID_STATE"

INVALID_STATE_TRANSITION = "INVALID_STATE_TRANSITION"

IO_ERROR = "IO_ERROR"

IPYNB_FILE_IN_REPO = "IPYNB_FILE_IN_REPO"

MALFORMED_PARTNER_RESPONSE = "MALFORMED_PARTNER_RESPONSE"

MALFORMED_REQUEST = "MALFORMED_REQUEST"

MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST = "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST"

MAX_BLOCK_SIZE_EXCEEDED = "MAX_BLOCK_SIZE_EXCEEDED"

MAX_CHILD_NODE_SIZE_EXCEEDED = "MAX_CHILD_NODE_SIZE_EXCEEDED"

MAX_LIST_SIZE_EXCEEDED = "MAX_LIST_SIZE_EXCEEDED"

MAX_NOTEBOOK_SIZE_EXCEEDED = "MAX_NOTEBOOK_SIZE_EXCEEDED"

MAX_READ_SIZE_EXCEEDED = "MAX_READ_SIZE_EXCEEDED"

METASTORE_ALREADY_EXISTS = "METASTORE_ALREADY_EXISTS"

METASTORE_DOES_NOT_EXIST = "METASTORE_DOES_NOT_EXIST"

METASTORE_NOT_EMPTY = "METASTORE_NOT_EMPTY"

NOT_FOUND = "NOT_FOUND"

NOT_IMPLEMENTED = "NOT_IMPLEMENTED"

PARTIAL_DELETE = "PARTIAL_DELETE"

PERMISSION_DENIED = "PERMISSION_DENIED"

PERMISSION_NOT_PROPAGATED = "PERMISSION_NOT_PROPAGATED"

PRINCIPAL_DOES_NOT_EXIST = "PRINCIPAL_DOES_NOT_EXIST"

PROJECTS_OPERATION_TIMEOUT = "PROJECTS_OPERATION_TIMEOUT"

PROVIDER_ALREADY_EXISTS = "PROVIDER_ALREADY_EXISTS"

PROVIDER_DOES_NOT_EXIST = "PROVIDER_DOES_NOT_EXIST"

PROVIDER_SHARE_NOT_ACCESSIBLE = "PROVIDER_SHARE_NOT_ACCESSIBLE"

QUOTA_EXCEEDED = "QUOTA_EXCEEDED"

RECIPIENT_ALREADY_EXISTS = "RECIPIENT_ALREADY_EXISTS"

RECIPIENT_DOES_NOT_EXIST = "RECIPIENT_DOES_NOT_EXIST"

REQUEST_LIMIT_EXCEEDED = "REQUEST_LIMIT_EXCEEDED"

RESOURCE_ALREADY_EXISTS = "RESOURCE_ALREADY_EXISTS"

RESOURCE_CONFLICT = "RESOURCE_CONFLICT"

RESOURCE_DOES_NOT_EXIST = "RESOURCE_DOES_NOT_EXIST"

RESOURCE_EXHAUSTED = "RESOURCE_EXHAUSTED"

RESOURCE_LIMIT_EXCEEDED = "RESOURCE_LIMIT_EXCEEDED"

SCHEMA_ALREADY_EXISTS = "SCHEMA_ALREADY_EXISTS"

SCHEMA_DOES_NOT_EXIST = "SCHEMA_DOES_NOT_EXIST"

SCHEMA_NOT_EMPTY = "SCHEMA_NOT_EMPTY"

SEARCH_QUERY_TOO_LONG = "SEARCH_QUERY_TOO_LONG"

SEARCH_QUERY_TOO_SHORT = "SEARCH_QUERY_TOO_SHORT"

SERVICE_UNDER_MAINTENANCE = "SERVICE_UNDER_MAINTENANCE"

SHARE_ALREADY_EXISTS = "SHARE_ALREADY_EXISTS"

SHARE_DOES_NOT_EXIST = "SHARE_DOES_NOT_EXIST"

STORAGE_CREDENTIAL_ALREADY_EXISTS = "STORAGE_CREDENTIAL_ALREADY_EXISTS"

STORAGE_CREDENTIAL_DOES_NOT_EXIST = "STORAGE_CREDENTIAL_DOES_NOT_EXIST"

TABLE_ALREADY_EXISTS = "TABLE_ALREADY_EXISTS"

TABLE_DOES_NOT_EXIST = "TABLE_DOES_NOT_EXIST"

TEMPORARILY_UNAVAILABLE = "TEMPORARILY_UNAVAILABLE"

UNAUTHENTICATED = "UNAUTHENTICATED"

UNAVAILABLE = "UNAVAILABLE"

UNKNOWN = "UNKNOWN"

UNPARSEABLE_HTTP_ERROR = "UNPARSEABLE_HTTP_ERROR"

WORKSPACE_TEMPORARILY_UNAVAILABLE = "WORKSPACE_TEMPORARILY_UNAVAILABLE"

class databricks.sdk.service.apps.GetAppPermissionLevelsResponse(permission_levels: 'Optional[List[AppPermissionsDescription]]' = None)

permission_levels: List[AppPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

Serializes the GetAppPermissionLevelsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GetAppPermissionLevelsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GetAppPermissionLevelsResponse

Deserializes the GetAppPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.apps.GitRepository(url: str, provider: str)

Git repository configuration specifying the location of the repository.

url: str

URL of the Git repository.

provider: str

Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.

as_dict() → dict

Serializes the GitRepository into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GitRepository into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GitRepository

Deserializes the GitRepository from a dictionary.

class databricks.sdk.service.apps.GitSource(branch: str | None = None, commit: str | None = None, git_repository: GitRepository | None = None, resolved_commit: str | None = None, source_code_path: str | None = None, tag: str | None = None)

Complete git source specification including repository location and reference.

branch: str | None = None

Git branch to checkout.

commit: str | None = None

Git commit SHA to checkout.

git_repository: GitRepository | None = None

Git repository configuration. Populated from the app’s git_repository configuration.

resolved_commit: str | None = None

The resolved commit SHA that was actually used for the deployment. This is populated by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch or tag pointed to at deployment time.

source_code_path: str | None = None

Relative path to the app source code within the Git repository. If not specified, the root of the repository is used.

tag: str | None = None

Git tag to checkout.

as_dict() → dict

Serializes the GitSource into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GitSource into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GitSource

Deserializes the GitSource from a dictionary.

class databricks.sdk.service.apps.ListAppDeploymentsResponse(app_deployments: 'Optional[List[AppDeployment]]' = None, next_page_token: 'Optional[str]' = None)

app_deployments: List[AppDeployment] | None = None

Deployment history of the app.

next_page_token: str | None = None

Pagination token to request the next page of apps.

as_dict() → dict

Serializes the ListAppDeploymentsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListAppDeploymentsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListAppDeploymentsResponse

Deserializes the ListAppDeploymentsResponse from a dictionary.

class databricks.sdk.service.apps.ListAppsResponse(apps: 'Optional[List[App]]' = None, next_page_token: 'Optional[str]' = None)

apps: List[App] | None = None

next_page_token: str | None = None

Pagination token to request the next page of apps.

as_dict() → dict

Serializes the ListAppsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListAppsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListAppsResponse

Deserializes the ListAppsResponse from a dictionary.

class databricks.sdk.service.apps.ListCustomTemplatesResponse(next_page_token: 'Optional[str]' = None, templates: 'Optional[List[CustomTemplate]]' = None)

next_page_token: str | None = None

Pagination token to request the next page of custom templates.

templates: List[CustomTemplate] | None = None

as_dict() → dict

Serializes the ListCustomTemplatesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListCustomTemplatesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListCustomTemplatesResponse

Deserializes the ListCustomTemplatesResponse from a dictionary.

class databricks.sdk.service.apps.ListSpacesResponse(next_page_token: 'Optional[str]' = None, spaces: 'Optional[List[Space]]' = None)

next_page_token: str | None = None

Pagination token to request the next page of app spaces.

spaces: List[Space] | None = None

as_dict() → dict

Serializes the ListSpacesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListSpacesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListSpacesResponse

Deserializes the ListSpacesResponse from a dictionary.

class databricks.sdk.service.apps.Operation(done: bool | None = None, error: DatabricksServiceExceptionWithDetailsProto | None = None, metadata: dict | None = None, name: str | None = None, response: dict | None = None)

This resource represents a long-running operation that is the result of a network API call.

done: bool | None = None

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

error: DatabricksServiceExceptionWithDetailsProto | None = None

The error result of the operation in case of failure or cancellation.

metadata: dict | None = None

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.

name: str | None = None

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

response: dict | None = None

The normal, successful response of the operation.

as_dict() → dict

Serializes the Operation into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Operation into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Operation

Deserializes the Operation from a dictionary.

class databricks.sdk.service.apps.Space(name: 'str', create_time: 'Optional[Timestamp]' = None, creator: 'Optional[str]' = None, description: 'Optional[str]' = None, effective_usage_policy_id: 'Optional[str]' = None, effective_user_api_scopes: 'Optional[List[str]]' = None, id: 'Optional[str]' = None, resources: 'Optional[List[AppResource]]' = None, service_principal_client_id: 'Optional[str]' = None, service_principal_id: 'Optional[int]' = None, service_principal_name: 'Optional[str]' = None, status: 'Optional[SpaceStatus]' = None, update_time: 'Optional[Timestamp]' = None, updater: 'Optional[str]' = None, usage_policy_id: 'Optional[str]' = None, user_api_scopes: 'Optional[List[str]]' = None)

name: str

The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.

create_time: Timestamp | None = None

The creation time of the app space. Formatted timestamp in ISO 6801.

creator: str | None = None

The email of the user that created the app space.

description: str | None = None

The description of the app space.

effective_usage_policy_id: str | None = None

The effective usage policy ID used by apps in the space.

effective_user_api_scopes: List[str] | None = None

The effective api scopes granted to the user access token.

id: str | None = None

The unique identifier of the app space.

resources: List[AppResource] | None = None

Resources for the app space. Resources configured at the space level are available to all apps in the space.

service_principal_client_id: str | None = None

The service principal client ID for the app space.

service_principal_id: int | None = None

The service principal ID for the app space.

service_principal_name: str | None = None

The service principal name for the app space.

status: SpaceStatus | None = None

The status of the app space.

update_time: Timestamp | None = None

The update time of the app space. Formatted timestamp in ISO 6801.

updater: str | None = None

The email of the user that last updated the app space.

usage_policy_id: str | None = None

The usage policy ID for managing cost at the space level.

user_api_scopes: List[str] | None = None

OAuth scopes for apps in the space.

as_dict() → dict

Serializes the Space into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Space into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Space

Deserializes the Space from a dictionary.

class databricks.sdk.service.apps.SpaceStatus(message: 'Optional[str]' = None, state: 'Optional[SpaceStatusSpaceState]' = None)

message: str | None = None

Message providing context about the current state.

state: SpaceStatusSpaceState | None = None

The state of the app space.

as_dict() → dict

Serializes the SpaceStatus into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SpaceStatus into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SpaceStatus

Deserializes the SpaceStatus from a dictionary.

class databricks.sdk.service.apps.SpaceStatusSpaceState

SPACE_ACTIVE = "SPACE_ACTIVE"

SPACE_CREATING = "SPACE_CREATING"

SPACE_DELETED = "SPACE_DELETED"

SPACE_DELETING = "SPACE_DELETING"

SPACE_ERROR = "SPACE_ERROR"

SPACE_UPDATING = "SPACE_UPDATING"

class databricks.sdk.service.apps.SpaceUpdate(description: str | None = None, resources: List[AppResource] | None = None, status: SpaceUpdateStatus | None = None, usage_policy_id: str | None = None, user_api_scopes: List[str] | None = None)

Tracks app space update information.

description: str | None = None

resources: List[AppResource] | None = None

status: SpaceUpdateStatus | None = None

usage_policy_id: str | None = None

user_api_scopes: List[str] | None = None

as_dict() → dict

Serializes the SpaceUpdate into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SpaceUpdate into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SpaceUpdate

Deserializes the SpaceUpdate from a dictionary.

class databricks.sdk.service.apps.SpaceUpdateState

FAILED = "FAILED"

IN_PROGRESS = "IN_PROGRESS"

NOT_UPDATED = "NOT_UPDATED"

SUCCEEDED = "SUCCEEDED"

class databricks.sdk.service.apps.SpaceUpdateStatus(message: str | None = None, state: SpaceUpdateState | None = None)

Status of an app space update operation

message: str | None = None

state: SpaceUpdateState | None = None

as_dict() → dict

Serializes the SpaceUpdateStatus into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SpaceUpdateStatus into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SpaceUpdateStatus

Deserializes the SpaceUpdateStatus from a dictionary.

class databricks.sdk.service.apps.TelemetryExportDestination(unity_catalog: UnityCatalog | None = None)

A single telemetry export destination with its configuration and status.

unity_catalog: UnityCatalog | None = None

as_dict() → dict

Serializes the TelemetryExportDestination into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the TelemetryExportDestination into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → TelemetryExportDestination

Deserializes the TelemetryExportDestination from a dictionary.

class databricks.sdk.service.apps.UnityCatalog(logs_table: str, metrics_table: str, traces_table: str)

Unity Catalog Destinations for OTEL telemetry export.

logs_table: str

Unity Catalog table for OTEL logs.

metrics_table: str

Unity Catalog table for OTEL metrics.

traces_table: str

Unity Catalog table for OTEL traces (spans).

as_dict() → dict

Serializes the UnityCatalog into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UnityCatalog into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UnityCatalog

Deserializes the UnityCatalog from a dictionary.