com.edmunds.rest.databricks.service

Interface LibraryService

All Known Implementing Classes:

LibraryServiceImpl

public interface LibraryService

The wrapper around the databricks Library API.

See Also:

https://docs.databricks.com/api/latest/libraries.html

Method Summary

Modifier and Type	Method and Description
ClusterLibraryStatusesDTO[]	allClusterStatuses() Gets the statuses of all clusters on a databricks instance.
ClusterLibraryStatusesDTO	clusterStatus(String clusterId) Gets the status of a specific cluster.
void	install(String clusterId, LibraryDTO[] libraries) Installs one or more libraries on a specific cluster.
void	uninstall(String clusterId, LibraryDTO[] libraries) Uninstalls one or more libraries from a specific cluster.
void	uninstallAll(String clusterId) Uninstalls all libraries from a specific cluster.

Method Detail

allClusterStatuses

ClusterLibraryStatusesDTO[] allClusterStatuses()
                                        throws IOException,
                                               DatabricksRestException

Gets the statuses of all clusters on a databricks instance.

Returns:

the array of all cluster statuses.

Throws:

IOException - any other errors.

DatabricksRestException - errors with db request.

See Also:

https://docs.databricks.com/api/latest/libraries.html#all-cluster-statuses

clusterStatus

ClusterLibraryStatusesDTO clusterStatus(String clusterId)
                                 throws IOException,
                                        DatabricksRestException

Gets the status of a specific cluster.

Parameters:

clusterId - the cluster id to get the status of

Returns:

the cluster status dto object

Throws:

IOException - any other errors

DatabricksRestException - errors with specific request

See Also:

https://docs.databricks.com/api/latest/libraries.html#cluster-status

install

void install(String clusterId,
             LibraryDTO[] libraries)
      throws IOException,
             DatabricksRestException

Installs one or more libraries on a specific cluster.

Parameters:

clusterId - the cluster to install to.

libraries - the libraries to install to this clsuter

Throws:

IOException - any other errors

DatabricksRestException - errors with specific request

See Also:

https://docs.databricks.com/api/latest/libraries.html#install

uninstall

void uninstall(String clusterId,
               LibraryDTO[] libraries)
        throws IOException,
               DatabricksRestException

Uninstalls one or more libraries from a specific cluster.

Parameters:

clusterId - the cluster to uninstall a library from

libraries - the libraries to uninstall

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/api/latest/libraries.html#uninstall

uninstallAll

void uninstallAll(String clusterId)
           throws IOException,
                  DatabricksRestException

Uninstalls all libraries from a specific cluster.

Throws:

IOException

DatabricksRestException

See Also:

https://docs.databricks.com/api/latest/libraries.html#uninstall