com.databricks.sdk.service.compute

Class LibrariesAPI

java.lang.Object

com.databricks.sdk.service.compute.LibrariesAPI

@Generated
public class LibrariesAPI
extends Object

The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster.

To make third-party or custom code available to notebooks and jobs running on your clusters, you can install a library. Libraries can be written in Python, Java, Scala, and R. You can upload Python, Java, Scala and R libraries and point to external packages in PyPI, Maven, and CRAN repositories.

Cluster libraries can be used by all notebooks running on a cluster. You can install a cluster library directly from a public repository such as PyPI or Maven, using a previously installed workspace library, or using an init script.

When you uninstall a library from a cluster, the library is removed only when you restart the cluster. Until you restart the cluster, the status of the uninstalled library appears as Uninstall pending restart.

Constructor Summary

Constructors

Constructor and Description
LibrariesAPI(ApiClient apiClient) Regular-use constructor
LibrariesAPI(LibrariesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Iterable<ClusterLibraryStatuses>	allClusterStatuses() Get the status of all libraries on all clusters.
Iterable<LibraryFullStatus>	clusterStatus(ClusterStatus request) Get the status of libraries on a cluster.
Iterable<LibraryFullStatus>	clusterStatus(String clusterId)
LibrariesService	impl()
void	install(InstallLibraries request) Add libraries to install on a cluster.
void	uninstall(UninstallLibraries request) Set libraries to uninstall from a cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

LibrariesAPI

public LibrariesAPI(ApiClient apiClient)

Regular-use constructor

LibrariesAPI

public LibrariesAPI(LibrariesService mock)

Constructor for mocks

Method Detail

allClusterStatuses

public Iterable<ClusterLibraryStatuses> allClusterStatuses()

Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster via the API or the libraries UI.

clusterStatus

public Iterable<LibraryFullStatus> clusterStatus(String clusterId)

clusterStatus

public Iterable<LibraryFullStatus> clusterStatus(ClusterStatus request)

Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API or the libraries UI. The order of returned libraries is as follows: 1. Libraries set to be installed on this cluster, in the order that the libraries were added to the cluster, are returned first. 2. Libraries that were previously requested to be installed on this cluster or, but are now marked for removal, in no particular order, are returned last.

install

public void install(InstallLibraries request)

Add libraries to install on a cluster. The installation is asynchronous; it happens in the background after the completion of this request.

uninstall

public void uninstall(UninstallLibraries request)

Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is restarted. A request to uninstall a library that is not currently installed is ignored.

impl

public LibrariesService impl()