Workspace

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

class databricks.sdk.service.workspace.AclItem(principal: str, permission: AclPermission)

An item representing an ACL rule applied to the given principal (user or group) on the associated scope point.

principal: str

The principal in which the permission is applied.

permission: AclPermission

The permission level applied to the principal.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AclItem from a dictionary.

class databricks.sdk.service.workspace.AclPermission

The ACL permission levels for Secret ACLs applied to secret scopes.

MANAGE = "MANAGE"

READ = "READ"

WRITE = "WRITE"

class databricks.sdk.service.workspace.AzureKeyVaultSecretScopeMetadata(resource_id: str, dns_name: str)

The metadata of the Azure KeyVault for a secret scope of type AZURE_KEYVAULT

resource_id: str

The resource id of the azure KeyVault that user wants to associate the scope with.

dns_name: str

The DNS of the KeyVault

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureKeyVaultSecretScopeMetadata from a dictionary.

class databricks.sdk.service.workspace.CreateCredentialsResponse(credential_id: 'int', git_provider: 'str', git_email: 'Optional[str]' = None, git_username: 'Optional[str]' = None, is_default_for_provider: 'Optional[bool]' = None, name: 'Optional[str]' = None)

credential_id: int

ID of the credential object in the workspace.

git_provider: str

The Git provider associated with the credential.

git_email: str | None = None

The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author & committer identity for commits. Required for most Git providers except AWS CodeCommit. Learn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider

git_username: str | None = None

The username provided with your Git provider account and associated with the credential. For most Git providers it is only used to set the Git committer & author names for commits, however it may be required for authentication depending on your Git provider / token requirements. Required for AWS CodeCommit.

is_default_for_provider: bool | None = None

if the credential is the default for the given provider

name: str | None = None

the name of the git credential, used for identification and ease of lookup

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateCredentialsResponse from a dictionary.

class databricks.sdk.service.workspace.CreateRepoResponse(branch: 'Optional[str]' = None, head_commit_id: 'Optional[str]' = None, id: 'Optional[int]' = None, path: 'Optional[str]' = None, provider: 'Optional[str]' = None, sparse_checkout: 'Optional[SparseCheckout]' = None, url: 'Optional[str]' = None)

branch: str | None = None

Branch that the Git folder (repo) is checked out to.

head_commit_id: str | None = None

SHA-1 hash representing the commit ID of the current HEAD of the Git folder (repo).

id: int | None = None

ID of the Git folder (repo) object in the workspace.

path: str | None = None

Path of the Git folder (repo) in the workspace.

provider: str | None = None

Git provider of the linked Git repository, e.g. gitHub, azureDevOpsServices, bitbucketServer (Bitbucket Data Center), gitLabEnterpriseEdition (GitLab Self-Managed), or awsCodeCommit (deprecated).

sparse_checkout: SparseCheckout | None = None

Sparse checkout settings for the Git folder (repo).

url: str | None = None

URL of the linked Git repository.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateRepoResponse from a dictionary.

class databricks.sdk.service.workspace.CredentialInfo(credential_id: 'int', git_email: 'Optional[str]' = None, git_provider: 'Optional[str]' = None, git_username: 'Optional[str]' = None, is_default_for_provider: 'Optional[bool]' = None, name: 'Optional[str]' = None)

credential_id: int

ID of the credential object in the workspace.

git_email: str | None = None

The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author & committer identity for commits. Required for most Git providers except AWS CodeCommit. Learn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider

git_provider: str | None = None

The Git provider associated with the credential. One of gitHub, bitbucketCloud, gitLab, azureDevOpsServices (Azure DevOps Services, including Microsoft Entra ID authentication), gitHubEnterprise, bitbucketServer (Bitbucket Data Center), gitLabEnterpriseEdition (GitLab Self-Managed), or awsCodeCommit (deprecated).

git_username: str | None = None

The username provided with your Git provider account and associated with the credential. For most Git providers it is only used to set the Git committer & author names for commits, however it may be required for authentication depending on your Git provider / token requirements. Required for AWS CodeCommit.

is_default_for_provider: bool | None = None

if the credential is the default for the given provider

name: str | None = None

the name of the git credential, used for identification and ease of lookup

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CredentialInfo from a dictionary.

class databricks.sdk.service.workspace.DeleteCredentialsResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteCredentialsResponse from a dictionary.

class databricks.sdk.service.workspace.DeleteRepoResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteRepoResponse from a dictionary.

class databricks.sdk.service.workspace.DeleteResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteResponse from a dictionary.

class databricks.sdk.service.workspace.DeleteSecretResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteSecretResponse from a dictionary.

class databricks.sdk.service.workspace.DirectoryInfo(is_git_folder: bool | None = None)

Additional metadata about a directory.

is_git_folder: bool | None = None

Whether the directory is a Git folder, whose contents are version-controlled by a remote Git repository. How a Git folder is represented depends on whether it has Git CLI access:

• A Git folder with Git CLI access has an object type of DIRECTORY, with this field set to true.

• A standard Git folder, which does not have Git CLI access, has an object type of REPO and does not include this field.

• A directory that is not Git-backed has this field set to false.

Use this field together with object_type to identify every Git folder in a workspace.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DirectoryInfo from a dictionary.

class databricks.sdk.service.workspace.ExportFormat

The format for workspace import and export.

AUTO = "AUTO"

DBC = "DBC"

HTML = "HTML"

JUPYTER = "JUPYTER"

RAW = "RAW"

R_MARKDOWN = "R_MARKDOWN"

SOURCE = "SOURCE"

class databricks.sdk.service.workspace.ExportOutputs

ALL = "ALL"

NONE = "NONE"

class databricks.sdk.service.workspace.ExportResponse(content: str | None = None, file_type: str | None = None)

The request field direct_download determines whether a JSON response or binary contents are returned by this endpoint.

content: str | None = None

The base64-encoded content. If the limit (10MB) is exceeded, exception with error code MAX_NOTEBOOK_SIZE_EXCEEDED is thrown.

file_type: str | None = None

The file type of the exported file.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExportResponse from a dictionary.

class databricks.sdk.service.workspace.GetCredentialsResponse(credential_id: 'int', git_email: 'Optional[str]' = None, git_provider: 'Optional[str]' = None, git_username: 'Optional[str]' = None, is_default_for_provider: 'Optional[bool]' = None, name: 'Optional[str]' = None)

credential_id: int

ID of the credential object in the workspace.

git_email: str | None = None

The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author & committer identity for commits. Required for most Git providers except AWS CodeCommit. Learn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider

git_provider: str | None = None

The Git provider associated with the credential.

git_username: str | None = None

The username provided with your Git provider account and associated with the credential. For most Git providers it is only used to set the Git committer & author names for commits, however it may be required for authentication depending on your Git provider / token requirements. Required for AWS CodeCommit.

is_default_for_provider: bool | None = None

if the credential is the default for the given provider

name: str | None = None

the name of the git credential, used for identification and ease of lookup

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetCredentialsResponse from a dictionary.

class databricks.sdk.service.workspace.GetRepoPermissionLevelsResponse(permission_levels: 'Optional[List[RepoPermissionsDescription]]' = None)

permission_levels: List[RepoPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetRepoPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.workspace.GetRepoResponse(branch: 'Optional[str]' = None, git_cli_enabled: 'Optional[bool]' = None, head_commit_id: 'Optional[str]' = None, id: 'Optional[int]' = None, path: 'Optional[str]' = None, provider: 'Optional[str]' = None, sparse_checkout: 'Optional[SparseCheckout]' = None, url: 'Optional[str]' = None)

branch: str | None = None

Branch that the local version of the repo is checked out to.

git_cli_enabled: bool | None = None

Whether the Git CLI is enabled for this Git folder (repo). When true, Git commands can be run directly against this Git folder using the Git CLI.

head_commit_id: str | None = None

SHA-1 hash representing the commit ID of the current HEAD of the repo.

id: int | None = None

ID of the Git folder (repo) object in the workspace.

path: str | None = None

Path of the Git folder (repo) in the workspace.

provider: str | None = None

Git provider of the linked Git repository, e.g. gitHub, azureDevOpsServices, bitbucketServer (Bitbucket Data Center), gitLabEnterpriseEdition (GitLab Self-Managed), or awsCodeCommit (deprecated).

sparse_checkout: SparseCheckout | None = None

Sparse checkout settings for the Git folder (repo).

url: str | None = None

URL of the linked Git repository.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetRepoResponse from a dictionary.

class databricks.sdk.service.workspace.GetSecretResponse(key: 'Optional[str]' = None, value: 'Optional[str]' = None)

key: str | None = None

A unique name to identify the secret.

value: str | None = None

The value of the secret in its byte representation.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetSecretResponse from a dictionary.

class databricks.sdk.service.workspace.GetWorkspaceObjectPermissionLevelsResponse(permission_levels: 'Optional[List[WorkspaceObjectPermissionsDescription]]' = None)

permission_levels: List[WorkspaceObjectPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetWorkspaceObjectPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.workspace.ImportFormat

The format for workspace import and export.

AUTO = "AUTO"

DBC = "DBC"

HTML = "HTML"

JUPYTER = "JUPYTER"

RAW = "RAW"

R_MARKDOWN = "R_MARKDOWN"

SOURCE = "SOURCE"

class databricks.sdk.service.workspace.ImportResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ImportResponse from a dictionary.

class databricks.sdk.service.workspace.Language

The language of notebook.

PYTHON = "PYTHON"

R = "R"

SCALA = "SCALA"

SQL = "SQL"

class databricks.sdk.service.workspace.ListAclsResponse(items: 'Optional[List[AclItem]]' = None)

items: List[AclItem] | None = None

The associated ACLs rule applied to principals in the given scope.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListAclsResponse from a dictionary.

class databricks.sdk.service.workspace.ListCredentialsResponse(credentials: 'Optional[List[CredentialInfo]]' = None)

credentials: List[CredentialInfo] | None = None

List of credentials.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListCredentialsResponse from a dictionary.

class databricks.sdk.service.workspace.ListReposResponse(next_page_token: 'Optional[str]' = None, repos: 'Optional[List[RepoInfo]]' = None)

next_page_token: str | None = None

Token that can be specified as a query parameter to the GET /repos endpoint to retrieve the next page of results.

repos: List[RepoInfo] | None = None

List of Git folders (repos).

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListReposResponse from a dictionary.

class databricks.sdk.service.workspace.ListResponse(objects: 'Optional[List[ObjectInfo]]' = None)

objects: List[ObjectInfo] | None = None

List of objects.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListResponse from a dictionary.

class databricks.sdk.service.workspace.ListScopesResponse(scopes: 'Optional[List[SecretScope]]' = None)

scopes: List[SecretScope] | None = None

The available secret scopes.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListScopesResponse from a dictionary.

class databricks.sdk.service.workspace.ListSecretsResponse(secrets: 'Optional[List[SecretMetadata]]' = None)

secrets: List[SecretMetadata] | None = None

Metadata information of all secrets contained within the given scope.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListSecretsResponse from a dictionary.

class databricks.sdk.service.workspace.MkdirsResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MkdirsResponse from a dictionary.

class databricks.sdk.service.workspace.ObjectInfo(created_at: int | None = None, directory_info: DirectoryInfo | None = None, language: Language | None = None, modified_at: int | None = None, object_id: int | None = None, object_type: ObjectType | None = None, path: str | None = None, resource_id: str | None = None, size: int | None = None)

The information of the object in workspace. It will be returned by list and get-status.

created_at: int | None = None

Only applicable to files. The creation UTC timestamp.

directory_info: DirectoryInfo | None = None

Additional metadata about the directory. Only set for objects of type DIRECTORY.

language: Language | None = None

The language of the object. This value is set only if the object type is NOTEBOOK. For Jupyter (.ipynb) notebooks, this is always PYTHON.

modified_at: int | None = None

Only applicable to files, the last modified UTC timestamp.

object_id: int | None = None

Unique identifier for the object.

object_type: ObjectType | None = None

The type of the object in workspace.

• NOTEBOOK: document that contains runnable code, visualizations, and explanatory text.

• DIRECTORY: directory

• LIBRARY: library

• FILE: file

• REPO: repository

• DASHBOARD: Lakeview dashboard

path: str | None = None

The absolute path of the object.

resource_id: str | None = None

A unique identifier for the object that is consistent across all Databricks APIs.

size: int | None = None

Only applicable to files. The file size in bytes can be returned.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ObjectInfo from a dictionary.

class databricks.sdk.service.workspace.ObjectType

The type of the object in workspace.

DASHBOARD = "DASHBOARD"

DIRECTORY = "DIRECTORY"

FILE = "FILE"

LIBRARY = "LIBRARY"

NOTEBOOK = "NOTEBOOK"

REPO = "REPO"

class databricks.sdk.service.workspace.RepoAccessControlRequest(group_name: 'Optional[str]' = None, permission_level: 'Optional[RepoPermissionLevel]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

group_name: str | None = None

name of the group

permission_level: RepoPermissionLevel | 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 RepoAccessControlRequest into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

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

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

Deserializes the RepoAccessControlRequest from a dictionary.

class databricks.sdk.service.workspace.RepoAccessControlResponse(all_permissions: 'Optional[List[RepoPermission]]' = 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[RepoPermission] | 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 RepoAccessControlResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

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

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

Deserializes the RepoAccessControlResponse from a dictionary.

class databricks.sdk.service.workspace.RepoInfo(branch: str | None = None, head_commit_id: str | None = None, id: int | None = None, path: str | None = None, provider: str | None = None, sparse_checkout: SparseCheckout | None = None, url: str | None = None)

Git folder (repo) information.

branch: str | None = None

Name of the current git branch of the git folder (repo).

head_commit_id: str | None = None

Current git commit id of the git folder (repo).

id: int | None = None

Id of the git folder (repo) in the Workspace.

path: str | None = None

Root path of the git folder (repo) in the Workspace.

provider: str | None = None

Git provider of the remote git repository, e.g. gitHub, azureDevOpsServices, bitbucketServer (Bitbucket Data Center), gitLabEnterpriseEdition (GitLab Self-Managed), or awsCodeCommit (deprecated).

sparse_checkout: SparseCheckout | None = None

Sparse checkout config for the git folder (repo).

url: str | None = None

URL of the remote git repository.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RepoInfo from a dictionary.

class databricks.sdk.service.workspace.RepoPermission(inherited: 'Optional[bool]' = None, inherited_from_object: 'Optional[List[str]]' = None, permission_level: 'Optional[RepoPermissionLevel]' = None)

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: RepoPermissionLevel | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RepoPermission from a dictionary.

class databricks.sdk.service.workspace.RepoPermissionLevel

Permission level

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_READ = "CAN_READ"

CAN_RUN = "CAN_RUN"

class databricks.sdk.service.workspace.RepoPermissions(access_control_list: 'Optional[List[RepoAccessControlResponse]]' = None, object_id: 'Optional[str]' = None, object_type: 'Optional[str]' = None)

access_control_list: List[RepoAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RepoPermissions from a dictionary.

class databricks.sdk.service.workspace.RepoPermissionsDescription(description: 'Optional[str]' = None, permission_level: 'Optional[RepoPermissionLevel]' = None)

description: str | None = None

permission_level: RepoPermissionLevel | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RepoPermissionsDescription from a dictionary.

class databricks.sdk.service.workspace.ScopeBackendType

The types of secret scope backends in the Secret Manager. Azure KeyVault backed secret scopes will be supported in a later release.

AZURE_KEYVAULT = "AZURE_KEYVAULT"

DATABRICKS = "DATABRICKS"

class databricks.sdk.service.workspace.SecretMetadata(key: str | None = None, last_updated_timestamp: int | None = None)

The metadata about a secret. Returned when listing secrets. Does not contain the actual secret value.

key: str | None = None

A unique name to identify the secret.

last_updated_timestamp: int | None = None

The last updated timestamp (in milliseconds) for the secret.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SecretMetadata from a dictionary.

class databricks.sdk.service.workspace.SecretScope(backend_type: ScopeBackendType | None = None, keyvault_metadata: AzureKeyVaultSecretScopeMetadata | None = None, name: str | None = None)

An organizational resource for storing secrets. Secret scopes can be different types (Databricks-managed, Azure KeyVault backed, etc), and ACLs can be applied to control permissions for all secrets within a scope.

backend_type: ScopeBackendType | None = None

The type of secret scope backend.

keyvault_metadata: AzureKeyVaultSecretScopeMetadata | None = None

The metadata for the secret scope if the type is AZURE_KEYVAULT

name: str | None = None

A unique name to identify the secret scope.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SecretScope from a dictionary.

class databricks.sdk.service.workspace.SparseCheckout(patterns: List[str] | None = None)

Sparse checkout configuration, it contains options like cone patterns.

patterns: List[str] | None = None

List of sparse checkout cone patterns, see cone mode handling for details.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SparseCheckout from a dictionary.

class databricks.sdk.service.workspace.SparseCheckoutUpdate(patterns: List[str] | None = None)

Sparse checkout configuration, it contains options like cone patterns.

patterns: List[str] | None = None

List of sparse checkout cone patterns, see cone mode handling for details.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SparseCheckoutUpdate from a dictionary.

class databricks.sdk.service.workspace.UpdateCredentialsResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateCredentialsResponse from a dictionary.

class databricks.sdk.service.workspace.UpdateRepoResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateRepoResponse from a dictionary.

class databricks.sdk.service.workspace.WorkspaceObjectAccessControlRequest(group_name: 'Optional[str]' = None, permission_level: 'Optional[WorkspaceObjectPermissionLevel]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

group_name: str | None = None

name of the group

permission_level: WorkspaceObjectPermissionLevel | 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 WorkspaceObjectAccessControlRequest into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceObjectAccessControlRequest from a dictionary.

class databricks.sdk.service.workspace.WorkspaceObjectAccessControlResponse(all_permissions: 'Optional[List[WorkspaceObjectPermission]]' = 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[WorkspaceObjectPermission] | 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 WorkspaceObjectAccessControlResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceObjectAccessControlResponse from a dictionary.

class databricks.sdk.service.workspace.WorkspaceObjectPermission(inherited: 'Optional[bool]' = None, inherited_from_object: 'Optional[List[str]]' = None, permission_level: 'Optional[WorkspaceObjectPermissionLevel]' = None)

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: WorkspaceObjectPermissionLevel | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceObjectPermission from a dictionary.

class databricks.sdk.service.workspace.WorkspaceObjectPermissionLevel

Permission level

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_READ = "CAN_READ"

CAN_RUN = "CAN_RUN"

class databricks.sdk.service.workspace.WorkspaceObjectPermissions(access_control_list: 'Optional[List[WorkspaceObjectAccessControlResponse]]' = None, object_id: 'Optional[str]' = None, object_type: 'Optional[str]' = None)

access_control_list: List[WorkspaceObjectAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceObjectPermissions from a dictionary.

class databricks.sdk.service.workspace.WorkspaceObjectPermissionsDescription(description: 'Optional[str]' = None, permission_level: 'Optional[WorkspaceObjectPermissionLevel]' = None)

description: str | None = None

permission_level: WorkspaceObjectPermissionLevel | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceObjectPermissionsDescription from a dictionary.