com.databricks.sdk.service.compute

Class ClustersAPI

java.lang.Object

com.databricks.sdk.service.compute.ClustersAPI

Direct Known Subclasses:

ClustersExt

@Generated
public class ClustersAPI
extends Object

The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.

Databricks maps cluster node instance types to compute units known as DBUs. See the instance type pricing page for a list of the supported instance types and their corresponding DBUs.

A Databricks cluster is a set of computation resources and configurations on which you run data engineering, data science, and data analytics workloads, such as production ETL pipelines, streaming analytics, ad-hoc analytics, and machine learning.

You run these workloads as a set of commands in a notebook or as an automated job. Databricks makes a distinction between all-purpose clusters and job clusters. You use all-purpose clusters to analyze data collaboratively using interactive notebooks. You use job clusters to run fast and robust automated jobs.

You can create an all-purpose cluster using the UI, CLI, or REST API. You can manually terminate and restart an all-purpose cluster. Multiple users can share such clusters to do collaborative interactive analysis.

IMPORTANT: Databricks retains cluster configuration information for up to 200 all-purpose clusters terminated in the last 30 days and up to 30 job clusters recently terminated by the job scheduler. To keep an all-purpose cluster configuration even after it has been terminated for more than 30 days, an administrator can pin a cluster to the cluster list.

Constructor Summary

Constructors

Constructor and Description
ClustersAPI(ApiClient apiClient) Regular-use constructor
ClustersAPI(ClustersService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	changeOwner(ChangeClusterOwner request) Change cluster owner.
void	changeOwner(String clusterId, String ownerUsername)
Wait<ClusterDetails,CreateClusterResponse>	create(CreateCluster request) Create new cluster.
Wait<ClusterDetails,CreateClusterResponse>	create(String sparkVersion)
Wait<ClusterDetails,Void>	delete(DeleteCluster request) Terminate cluster.
Wait<ClusterDetails,Void>	delete(String clusterId)
Wait<ClusterDetails,Void>	edit(EditCluster request) Update cluster configuration.
Wait<ClusterDetails,Void>	edit(String clusterId, String sparkVersion)
Iterable<ClusterEvent>	events(GetEvents request) List cluster activity events.
Iterable<ClusterEvent>	events(String clusterId)
ClusterDetails	get(GetClusterRequest request) Get cluster info.
ClusterDetails	get(String clusterId)
GetClusterPermissionLevelsResponse	getClusterPermissionLevels(GetClusterPermissionLevelsRequest request) Get cluster permission levels.
GetClusterPermissionLevelsResponse	getClusterPermissionLevels(String clusterId)
ClusterPermissions	getClusterPermissions(GetClusterPermissionsRequest request) Get cluster permissions.
ClusterPermissions	getClusterPermissions(String clusterId)
ClustersService	impl()
Iterable<ClusterDetails>	list(ListClustersRequest request) List all clusters.
ListNodeTypesResponse	listNodeTypes() List node types.
ListAvailableZonesResponse	listZones() List availability zones.
void	permanentDelete(PermanentDeleteCluster request) Permanently delete cluster.
void	permanentDelete(String clusterId)
void	pin(PinCluster request) Pin cluster.
void	pin(String clusterId)
Wait<ClusterDetails,Void>	resize(ResizeCluster request) Resize cluster.
Wait<ClusterDetails,Void>	resize(String clusterId)
Wait<ClusterDetails,Void>	restart(RestartCluster request) Restart cluster.
Wait<ClusterDetails,Void>	restart(String clusterId)
ClusterPermissions	setClusterPermissions(ClusterPermissionsRequest request) Set cluster permissions.
ClusterPermissions	setClusterPermissions(String clusterId)
GetSparkVersionsResponse	sparkVersions() List available Spark versions.
Wait<ClusterDetails,Void>	start(StartCluster request) Start terminated cluster.
Wait<ClusterDetails,Void>	start(String clusterId)
void	unpin(String clusterId)
void	unpin(UnpinCluster request) Unpin cluster.
ClusterPermissions	updateClusterPermissions(ClusterPermissionsRequest request) Update cluster permissions.
ClusterPermissions	updateClusterPermissions(String clusterId)
ClusterDetails	waitGetClusterRunning(String clusterId)
ClusterDetails	waitGetClusterRunning(String clusterId, Duration timeout, Consumer<ClusterDetails> callback)
ClusterDetails	waitGetClusterTerminated(String clusterId)
ClusterDetails	waitGetClusterTerminated(String clusterId, Duration timeout, Consumer<ClusterDetails> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClustersAPI

public ClustersAPI(ApiClient apiClient)

Regular-use constructor

ClustersAPI

public ClustersAPI(ClustersService mock)

Constructor for mocks

Method Detail

waitGetClusterRunning

public ClusterDetails waitGetClusterRunning(String clusterId)
                                     throws TimeoutException

Throws:

TimeoutException

waitGetClusterRunning

public ClusterDetails waitGetClusterRunning(String clusterId,
                                            Duration timeout,
                                            Consumer<ClusterDetails> callback)
                                     throws TimeoutException

Throws:

TimeoutException

waitGetClusterTerminated

public ClusterDetails waitGetClusterTerminated(String clusterId)
                                        throws TimeoutException

Throws:

TimeoutException

waitGetClusterTerminated

public ClusterDetails waitGetClusterTerminated(String clusterId,
                                               Duration timeout,
                                               Consumer<ClusterDetails> callback)
                                        throws TimeoutException

Throws:

TimeoutException

changeOwner

public void changeOwner(String clusterId,
                        String ownerUsername)

changeOwner

public void changeOwner(ChangeClusterOwner request)

Change cluster owner.

Change the owner of the cluster. You must be an admin to perform this operation.

create

public Wait<ClusterDetails,CreateClusterResponse> create(String sparkVersion)

create

public Wait<ClusterDetails,CreateClusterResponse> create(CreateCluster request)

Create new cluster.

Creates a new Spark cluster. This method will acquire new instances from the cloud provider if necessary. Note: Databricks may not be able to acquire some of the requested nodes, due to cloud provider limitations (account limits, spot price, etc.) or transient network issues.

If Databricks acquires at least 85% of the requested on-demand nodes, cluster creation will succeed. Otherwise the cluster will terminate with an informative error message.

delete

public Wait<ClusterDetails,Void> delete(String clusterId)

delete

public Wait<ClusterDetails,Void> delete(DeleteCluster request)

Terminate cluster.

Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once the termination has completed, the cluster will be in a `TERMINATED` state. If the cluster is already in a `TERMINATING` or `TERMINATED` state, nothing will happen.

edit

public Wait<ClusterDetails,Void> edit(String clusterId,
                                      String sparkVersion)

edit

public Wait<ClusterDetails,Void> edit(EditCluster request)

Update cluster configuration.

Updates the configuration of a cluster to match the provided attributes and size. A cluster can be updated if it is in a `RUNNING` or `TERMINATED` state.

If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes can take effect.

If a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The next time it is started using the `clusters/start` API, the new attributes will take effect. Any attempt to update a cluster in any other state will be rejected with an `INVALID_STATE` error code.

Clusters created by the Databricks Jobs service cannot be edited.

events

public Iterable<ClusterEvent> events(String clusterId)

events

public Iterable<ClusterEvent> events(GetEvents request)

List cluster activity events.

Retrieves a list of events about the activity of a cluster. This API is paginated. If there are more events to read, the response includes all the nparameters necessary to request the next page of events.

get

public ClusterDetails get(String clusterId)

get

public ClusterDetails get(GetClusterRequest request)

Get cluster info.

Retrieves the information for a cluster given its identifier. Clusters can be described while they are running, or up to 60 days after they are terminated.

getClusterPermissionLevels

public GetClusterPermissionLevelsResponse getClusterPermissionLevels(String clusterId)

getClusterPermissionLevels

public GetClusterPermissionLevelsResponse getClusterPermissionLevels(GetClusterPermissionLevelsRequest request)

Get cluster permission levels.

Gets the permission levels that a user can have on an object.

getClusterPermissions

public ClusterPermissions getClusterPermissions(String clusterId)

getClusterPermissions

public ClusterPermissions getClusterPermissions(GetClusterPermissionsRequest request)

Get cluster permissions.

Gets the permissions of a cluster. Clusters can inherit permissions from their root object.

list

public Iterable<ClusterDetails> list(ListClustersRequest request)

List all clusters.

Return information about all pinned clusters, active clusters, up to 200 of the most recently terminated all-purpose clusters in the past 30 days, and up to 30 of the most recently terminated job clusters in the past 30 days.

For example, if there is 1 pinned cluster, 4 active clusters, 45 terminated all-purpose clusters in the past 30 days, and 50 terminated job clusters in the past 30 days, then this API returns the 1 pinned cluster, 4 active clusters, all 45 terminated all-purpose clusters, and the 30 most recently terminated job clusters.

listNodeTypes

public ListNodeTypesResponse listNodeTypes()

List node types.

Returns a list of supported Spark node types. These node types can be used to launch a cluster.

listZones

public ListAvailableZonesResponse listZones()

List availability zones.

Returns a list of availability zones where clusters can be created in (For example, us-west-2a). These zones can be used to launch a cluster.

permanentDelete

public void permanentDelete(String clusterId)

permanentDelete

public void permanentDelete(PermanentDeleteCluster request)

Permanently delete cluster.

Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously removed.

In addition, users will no longer see permanently deleted clusters in the cluster list, and API users can no longer perform any action on permanently deleted clusters.

pin

public void pin(String clusterId)

pin

public void pin(PinCluster request)

Pin cluster.

Pinning a cluster ensures that the cluster will always be returned by the ListClusters API. Pinning a cluster that is already pinned will have no effect. This API can only be called by workspace admins.

resize

public Wait<ClusterDetails,Void> resize(String clusterId)

resize

public Wait<ClusterDetails,Void> resize(ResizeCluster request)

Resize cluster.

Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a `RUNNING` state.

restart

public Wait<ClusterDetails,Void> restart(String clusterId)

restart

public Wait<ClusterDetails,Void> restart(RestartCluster request)

Restart cluster.

Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a `RUNNING` state, nothing will happen.

setClusterPermissions

public ClusterPermissions setClusterPermissions(String clusterId)

setClusterPermissions

public ClusterPermissions setClusterPermissions(ClusterPermissionsRequest request)

Set cluster permissions.

Sets permissions on a cluster. Clusters can inherit permissions from their root object.

sparkVersions

public GetSparkVersionsResponse sparkVersions()

List available Spark versions.

Returns the list of available Spark versions. These versions can be used to launch a cluster.

start

public Wait<ClusterDetails,Void> start(String clusterId)

start

public Wait<ClusterDetails,Void> start(StartCluster request)

Start terminated cluster.

Starts a terminated Spark cluster with the supplied ID. This works similar to `createCluster` except:

* The previous cluster id and attributes are preserved. * The cluster starts with the last specified cluster size. * If the previous cluster was an autoscaling cluster, the current cluster starts with the minimum number of nodes. * If the cluster is not currently in a `TERMINATED` state, nothing will happen. * Clusters launched to run a job cannot be started.

unpin

public void unpin(String clusterId)

unpin

public void unpin(UnpinCluster request)

Unpin cluster.

Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API. Unpinning a cluster that is not pinned will have no effect. This API can only be called by workspace admins.

updateClusterPermissions

public ClusterPermissions updateClusterPermissions(String clusterId)

updateClusterPermissions

public ClusterPermissions updateClusterPermissions(ClusterPermissionsRequest request)

Update cluster permissions.

Updates the permissions on a cluster. Clusters can inherit permissions from their root object.

impl

public ClustersService impl()