clusterlibraries

package
v0.0.1-dev.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, opts ...client.Option) (*Client, error)

func (*Client) 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.

func (*Client) ClusterStatus

func (c *Client) ClusterStatus(ctx context.Context, req ClusterStatusRequest, opts ...call.Option) (*ClusterLibraryStatuses, error)

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.

func (*Client) InstallLibraries

func (c *Client) InstallLibraries(ctx context.Context, req InstallLibrariesRequest, opts ...call.Option) (*InstallLibrariesResponse, error)

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

func (*Client) UninstallLibraries

func (c *Client) UninstallLibraries(ctx context.Context, req UninstallLibrariesRequest, opts ...call.Option) (*UninstallLibrariesResponse, error)

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.

type ClusterLibraryStatuses

type ClusterLibraryStatuses struct {
	// Unique identifier for the cluster.
	ClusterId *string
	// Status of all libraries on the cluster.
	LibraryStatuses []LibraryFullStatus
}

type ClusterStatusRequest

type ClusterStatusRequest struct {
	// Unique identifier of the cluster whose status should be retrieved.
	ClusterId *string
}

type InstallLibrariesRequest

type InstallLibrariesRequest struct {
	// Unique identifier for the cluster on which to install these libraries.
	ClusterId *string
	// The libraries to install.
	Libraries []Library
}

type InstallLibrariesResponse

type InstallLibrariesResponse struct {
}

type Library

type Library struct {
	Lib isLibrary_Lib
}

type LibraryFullStatus

type LibraryFullStatus struct {
	// Unique identifier for the library.
	Library *Library
	// Status of installing the library on the cluster.
	Status LibraryInstallStatus
	// All the info and warning messages that have occurred so far for this library.
	Messages []string
	// Whether the library was set to be installed on all clusters via the libraries
	// UI.
	IsLibraryForAllClusters *bool
}

The status of the library on a specific cluster..

type LibraryInstallStatus

type LibraryInstallStatus string

The status of a library on a specific cluster.

const (
	LibraryInstallStatus_Unspecified LibraryInstallStatus = ""
	// Metadata necessary to install the library is being retrieved from the
	// provided repository.
	//
	// For jar and egg libraries, this step is a no-op.
	LibraryInstallStatus_Resolving LibraryInstallStatus = "RESOLVING"
	// The library is actively being installed, either by adding resources to Spark
	// or executing system commands inside the Spark nodes.
	LibraryInstallStatus_Installing LibraryInstallStatus = "INSTALLING"
	// The library has been successfully installed and can now be used.
	LibraryInstallStatus_Installed LibraryInstallStatus = "INSTALLED"
	// Some step in installation failed. More information can be found in the
	// `messages` field.
	LibraryInstallStatus_Failed LibraryInstallStatus = "FAILED"
	// The library has been marked for removal. Currently, libraries can only be
	// removed when clusters are restarted, so libraries that enter this state will
	// remain until the cluster is restarted.
	LibraryInstallStatus_UninstallOnRestart LibraryInstallStatus = "UNINSTALL_ON_RESTART"
	// Indicates that Library Manager decided to skip installation for this library.
	// For example, shared libraries on DBR 7+ are skipped.
	LibraryInstallStatus_Skipped LibraryInstallStatus = "SKIPPED"
	// Library installation is restored and can be used.
	LibraryInstallStatus_Restored LibraryInstallStatus = "RESTORED"
)

type Library_Lib_Cran

type Library_Lib_Cran struct {
	Cran RCranLibrary
}

Library_Lib_Cran selects Cran for Library.Lib. Specification of a CRAN library to be installed as part of the library

type Library_Lib_Egg

type Library_Lib_Egg struct {
	Egg string
}

Library_Lib_Egg selects Egg for Library.Lib. Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.

type Library_Lib_Jar

type Library_Lib_Jar struct {
	Jar string
}

Library_Lib_Jar selects Jar for Library.Lib. URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `{ "jar": "/Workspace/path/to/library.jar" }`, `{ "jar" : "/Volumes/path/to/library.jar" }` or `{ "jar": "s3://my-bucket/library.jar" }`. If S3 is used, please make sure the cluster has read access on the library. You may need to launch the cluster with an IAM role to access the S3 URI.

type Library_Lib_Maven

type Library_Lib_Maven struct {
	Maven MavenLibrary
}

Library_Lib_Maven selects Maven for Library.Lib. Specification of a maven library to be installed. For example: `{ "coordinates": "org.jsoup:jsoup:1.7.2" }`

type Library_Lib_Pypi

type Library_Lib_Pypi struct {
	Pypi PythonPyPiLibrary
}

Library_Lib_Pypi selects Pypi for Library.Lib. Specification of a PyPi library to be installed. For example: `{ "package": "simplejson" }`

type Library_Lib_Requirements

type Library_Lib_Requirements struct {
	Requirements string
}

Library_Lib_Requirements selects Requirements for Library.Lib. URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`

type Library_Lib_Whl

type Library_Lib_Whl struct {
	Whl string
}

Library_Lib_Whl selects Whl for Library.Lib. URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `{ "whl": "/Workspace/path/to/library.whl" }`, `{ "whl" : "/Volumes/path/to/library.whl" }` or `{ "whl": "s3://my-bucket/library.whl" }`. If S3 is used, please make sure the cluster has read access on the library. You may need to launch the cluster with an IAM role to access the S3 URI.

type ListAllClusterLibraryStatusesRequest

type ListAllClusterLibraryStatusesRequest struct {
}

type ListAllClusterLibraryStatusesResponse

type ListAllClusterLibraryStatusesResponse struct {
	// A list of cluster statuses.
	Statuses []ClusterLibraryStatuses
}

type MavenLibrary

type MavenLibrary struct {
	// Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2".
	Coordinates *string
	// Maven repo to install the Maven package from. If omitted, both Maven Central
	// Repository and Spark Packages are searched.
	Repo *string
	// List of dependences to exclude. For example: `["slf4j:slf4j",
	// "*:hadoop-client"]`.
	//
	// Maven dependency exclusions:
	// https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.
	Exclusions []string
}

type PythonPyPiLibrary

type PythonPyPiLibrary struct {
	// The name of the pypi package to install. An optional exact version
	// specification is also supported. Examples: "simplejson" and
	// "simplejson==3.8.0".
	Package *string
	// The repository where the package can be found. If not specified, the default
	// pip index is used.
	Repo *string
}

type RCranLibrary

type RCranLibrary struct {
	// The name of the CRAN package to install.
	Package *string
	// The repository where the package can be found. If not specified, the default
	// CRAN repo is used.
	Repo *string
}

type UninstallLibrariesRequest

type UninstallLibrariesRequest struct {
	// Unique identifier for the cluster on which to uninstall these libraries.
	ClusterId *string
	// The libraries to uninstall.
	Libraries []Library
}

type UninstallLibrariesResponse

type UninstallLibrariesResponse struct {
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL