Databricks SDK for JavaScript
    Preparing search index...

    The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines. In this minimal environment spec, only pip and java dependencies are supported.

    interface Environment {
        baseEnvironment?: string;
        client?: string;
        dependencies?: string[];
        environmentVersion?: string;
        javaDependencies?: string[];
        projectEnvironment?: string;
    }
    Index

    Properties

    baseEnvironment?: string

    The base environment this environment is built on top of. A base environment defines the environment version and a list of dependencies for serverless compute. The value can be a file path to a custom env.yaml file (e.g., /Workspace/path/to/env.yaml).

    Support for a Databricks-provided base environment ID (e.g., workspace-base-environments/databricks_ai_v4) and workspace base environment ID (e.g., workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7) is in Beta.

    Either environment_version or base_environment can be provided.

    For more information about Databricks-provided base environments, see the list workspace base environments API.

    client?: string

    Use environment_version instead.

    dependencies?: string[]

    List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a valid pip requirements file line. Allowed dependencies include a requirement specifier, an archive URL, a local project path (such as WSFS or UC Volumes in Databricks), or a VCS project URL.

    environmentVersion?: string

    The environment version used by this environment. Either environment_version or base_environment must be provided. Each version comes with a specific Python version and a set of Python packages. The version is a string, consisting of an integer.

    javaDependencies?: string[]

    List of Java dependencies. Each dependency is a string representing a Java library path. For example: /Volumes/path/to/test.jar.

    projectEnvironment?: string

    Path to the pyproject.toml file that defines the project environment. This field cannot be combined with environment_version, base_environment, dependency fields, or any other environment-source fields. Set the environment version and dependencies in pyproject.toml instead.