| Interface | Description |
|---|---|
| ClusterPoliciesService |
You can use cluster policies to control users' ability to configure clusters based on a set of
rules.
|
| ClustersService |
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
| CommandExecutionService |
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
| GlobalInitScriptsService |
The Global Init Scripts API enables Workspace administrators to configure global initialization
scripts for their workspace.
|
| InstancePoolsService |
Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use
cloud instances which reduces a cluster start and auto-scaling times.
|
| InstanceProfilesService |
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
| LibrariesService |
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
| PolicyComplianceForClustersService |
The policy compliance APIs allow you to view and manage the policy compliance status of clusters
in your workspace.
|
| PolicyFamiliesService |
View available policy families.
|
| Class | Description |
|---|---|
| AddInstanceProfile | |
| Adlsgen2Info |
A storage location in Adls Gen2
|
| AutoScale | |
| AwsAttributes |
Attributes set during cluster creation which are related to Amazon Web Services.
|
| AzureAttributes |
Attributes set during cluster creation which are related to Microsoft Azure.
|
| CancelCommand | |
| ChangeClusterOwner | |
| ClientsTypes | |
| CloneCluster | |
| CloudProviderNodeInfo | |
| ClusterAccessControlRequest | |
| ClusterAccessControlResponse | |
| ClusterAttributes |
Common set of attributes set during cluster creation.
|
| ClusterCompliance | |
| ClusterDetails |
Describes all of the metadata about a single Spark cluster in Databricks.
|
| ClusterEvent | |
| ClusterLibraryStatuses | |
| ClusterLogConf |
Cluster log delivery config
|
| ClusterPermission | |
| ClusterPermissions | |
| ClusterPermissionsDescription | |
| ClusterPermissionsRequest | |
| ClusterPoliciesAPI |
You can use cluster policies to control users' ability to configure clusters based on a set of
rules.
|
| ClusterPolicyAccessControlRequest | |
| ClusterPolicyAccessControlResponse | |
| ClusterPolicyPermission | |
| ClusterPolicyPermissions | |
| ClusterPolicyPermissionsDescription | |
| ClusterPolicyPermissionsRequest | |
| ClustersAPI |
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
| ClusterSettingsChange |
Represents a change to the cluster settings required for the cluster to become compliant with its
policy.
|
| ClusterSize | |
| ClusterSpec |
Contains a snapshot of the latest user specified settings that were used to create/edit the
cluster.
|
| ClusterStatus | |
| Command | |
| CommandExecutionAPI |
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
| CommandStatusRequest | |
| CommandStatusResponse | |
| ContextStatusRequest | |
| ContextStatusResponse | |
| CreateCluster | |
| CreateClusterResponse | |
| CreateContext | |
| Created | |
| CreateInstancePool | |
| CreateInstancePoolResponse | |
| CreatePolicy | |
| CreatePolicyResponse | |
| CreateResponse | |
| CustomPolicyTag | |
| DataPlaneEventDetails | |
| DbfsStorageInfo |
A storage location in DBFS
|
| DeleteCluster | |
| DeleteGlobalInitScriptRequest | |
| DeleteInstancePool | |
| DeletePolicy | |
| DestroyContext | |
| DiskSpec |
Describes the disks that are launched for each instance in the spark cluster.
|
| DiskType |
Describes the disk type.
|
| DockerBasicAuth | |
| DockerImage | |
| EditCluster | |
| EditInstancePool | |
| EditPolicy | |
| EnforceClusterComplianceRequest | |
| EnforceClusterComplianceResponse | |
| Environment |
The environment entity used to preserve serverless environment side panel, jobs' environment for
non-notebook task, and DLT's environment for classic and serverless pipelines.
|
| EventDetails | |
| GcpAttributes |
Attributes set during cluster creation which are related to GCP.
|
| GcsStorageInfo |
A storage location in Google Cloud Platform's GCS
|
| GetClusterComplianceRequest | |
| GetClusterComplianceResponse | |
| GetClusterPermissionLevelsRequest | |
| GetClusterPermissionLevelsResponse | |
| GetClusterPermissionsRequest | |
| GetClusterPolicyPermissionLevelsRequest | |
| GetClusterPolicyPermissionLevelsResponse | |
| GetClusterPolicyPermissionsRequest | |
| GetClusterPolicyRequest | |
| GetClusterRequest | |
| GetEvents | |
| GetEventsResponse | |
| GetGlobalInitScriptRequest | |
| GetInstancePool | |
| GetInstancePoolPermissionLevelsRequest | |
| GetInstancePoolPermissionLevelsResponse | |
| GetInstancePoolPermissionsRequest | |
| GetInstancePoolRequest | |
| GetPolicyFamilyRequest | |
| GetSparkVersionsResponse | |
| GlobalInitScriptCreateRequest | |
| GlobalInitScriptDetails | |
| GlobalInitScriptDetailsWithContent | |
| GlobalInitScriptsAPI |
The Global Init Scripts API enables Workspace administrators to configure global initialization
scripts for their workspace.
|
| GlobalInitScriptUpdateRequest | |
| InitScriptEventDetails | |
| InitScriptInfo |
Config for an individual init script Next ID: 11
|
| InitScriptInfoAndExecutionDetails | |
| InstallLibraries | |
| InstancePoolAccessControlRequest | |
| InstancePoolAccessControlResponse | |
| InstancePoolAndStats | |
| InstancePoolAwsAttributes |
Attributes set during instance pool creation which are related to Amazon Web Services.
|
| InstancePoolAzureAttributes |
Attributes set during instance pool creation which are related to Azure.
|
| InstancePoolGcpAttributes |
Attributes set during instance pool creation which are related to GCP.
|
| InstancePoolPermission | |
| InstancePoolPermissions | |
| InstancePoolPermissionsDescription | |
| InstancePoolPermissionsRequest | |
| InstancePoolsAPI |
Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use
cloud instances which reduces a cluster start and auto-scaling times.
|
| InstancePoolStats | |
| InstancePoolStatus | |
| InstanceProfile | |
| InstanceProfilesAPI |
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
| LibrariesAPI |
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
| Library | |
| LibraryFullStatus |
The status of the library on a specific cluster.
|
| ListAllClusterLibraryStatusesResponse | |
| ListAvailableZonesResponse | |
| ListClusterCompliancesRequest | |
| ListClusterCompliancesResponse | |
| ListClusterPoliciesRequest | |
| ListClustersFilterBy | |
| ListClustersRequest | |
| ListClustersResponse | |
| ListClustersSortBy | |
| ListGlobalInitScriptsResponse | |
| ListInstancePools | |
| ListInstanceProfilesResponse | |
| ListNodeTypesResponse | |
| ListPoliciesResponse | |
| ListPolicyFamiliesRequest | |
| ListPolicyFamiliesResponse | |
| LocalFileInfo | |
| LogAnalyticsInfo | |
| LogSyncStatus |
The log delivery status
|
| MavenLibrary | |
| NodeInstanceType |
This structure embodies the machine type that hosts spark containers Note: this should be an
internal data structure for now It is defined in proto in case we want to send it over the wire
in the future (which is likely)
|
| NodeType |
A description of a Spark node type including both the dimensions of the node and the instance
type on which it will be hosted.
|
| NodeTypeFlexibility |
Configuration for flexible node types, allowing fallback to alternate node types during cluster
launch and upscale.
|
| PendingInstanceError |
Error message of a failed pending instances
|
| PermanentDeleteCluster | |
| PinCluster | |
| Policy |
Describes a Cluster Policy entity.
|
| PolicyComplianceForClustersAPI |
The policy compliance APIs allow you to view and manage the policy compliance status of clusters
in your workspace.
|
| PolicyFamiliesAPI |
View available policy families.
|
| PolicyFamily | |
| PythonPyPiLibrary | |
| RCranLibrary | |
| RemoveInstanceProfile | |
| ResizeCluster | |
| RestartCluster | |
| Results | |
| S3StorageInfo |
A storage location in Amazon S3
|
| SparkNode |
Describes a specific Spark driver or executor.
|
| SparkNodeAwsAttributes |
Attributes specific to AWS for a Spark node.
|
| SparkVersion | |
| StartCluster | |
| TerminationReason | |
| UninstallLibraries | |
| UnpinCluster | |
| UpdateCluster | |
| UpdateClusterResource | |
| VolumesStorageInfo |
A storage location back by UC Volumes.
|
| WorkloadType |
Cluster Attributes showing for clusters workload types.
|
| WorkspaceStorageInfo |
A storage location in Workspace Filesystem (WSFS)
|
| Enum | Description |
|---|---|
| AwsAvailability |
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
| AzureAvailability |
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
| CloudProviderNodeStatus | |
| ClusterPermissionLevel |
Permission level
|
| ClusterPolicyPermissionLevel |
Permission level
|
| ClusterSource |
Determines whether the cluster was created by a user through the UI, created by the Databricks
Jobs Scheduler, or through an API request.
|
| CommandStatus | |
| ContextStatus | |
| DataPlaneEventDetailsEventType | |
| DataSecurityMode |
Data security mode decides what data governance model to use when accessing data from a cluster.
|
| DiskTypeAzureDiskVolumeType |
All Azure Disk types that Databricks supports.
|
| DiskTypeEbsVolumeType |
All EBS volume types that Databricks supports.
|
| EbsVolumeType |
All EBS volume types that Databricks supports.
|
| EventDetailsCause |
The cause of a change in target size.
|
| EventType | |
| GcpAvailability |
This field determines whether the instance pool will contain preemptible VMs, on-demand VMs, or
preemptible VMs with a fallback to on-demand VMs if the former is unavailable.
|
| GetEventsOrder | |
| HardwareAcceleratorType |
HardwareAcceleratorType: The type of hardware accelerator to use for compute workloads.
|
| InitScriptExecutionDetailsInitScriptExecutionStatus |
Result of attempted script execution
|
| InstancePoolAwsAttributesAvailability |
The set of AWS availability types supported when setting up nodes for a cluster.
|
| InstancePoolAzureAttributesAvailability |
The set of Azure availability types supported when setting up nodes for a cluster.
|
| InstancePoolPermissionLevel |
Permission level
|
| InstancePoolState |
The state of a Cluster.
|
| Kind |
The kind of compute described by this compute specification.
|
| Language | |
| LibraryInstallStatus |
The status of a library on a specific cluster.
|
| ListClustersSortByDirection | |
| ListClustersSortByField | |
| ListSortColumn | |
| ListSortOrder | |
| ResultType | |
| RuntimeEngine | |
| State |
The state of a Cluster.
|
| TerminationReasonCode |
The status code indicating why the cluster was terminated
|
| TerminationReasonType |
type of the termination
|
Copyright © 2026. All rights reserved.