com.databricks.sdk.service.environments

Interface EnvironmentsService

@Generated
public interface EnvironmentsService

APIs to manage environment resources.

The Environments API provides management capabilities for different types of environments including workspace-level base environments that define the environment version and dependencies to be used in serverless notebooks and jobs.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
Operation	createWorkspaceBaseEnvironment(CreateWorkspaceBaseEnvironmentRequest createWorkspaceBaseEnvironmentRequest) Creates a new WorkspaceBaseEnvironment.
void	deleteWorkspaceBaseEnvironment(DeleteWorkspaceBaseEnvironmentRequest deleteWorkspaceBaseEnvironmentRequest) Deletes a WorkspaceBaseEnvironment.
DefaultWorkspaceBaseEnvironment	getDefaultWorkspaceBaseEnvironment(GetDefaultWorkspaceBaseEnvironmentRequest getDefaultWorkspaceBaseEnvironmentRequest) Gets the default WorkspaceBaseEnvironment configuration for the workspace.
Operation	getOperation(GetOperationRequest getOperationRequest) Gets the status of a long-running operation.
WorkspaceBaseEnvironment	getWorkspaceBaseEnvironment(GetWorkspaceBaseEnvironmentRequest getWorkspaceBaseEnvironmentRequest) Retrieves a WorkspaceBaseEnvironment by its name.
ListWorkspaceBaseEnvironmentsResponse	listWorkspaceBaseEnvironments(ListWorkspaceBaseEnvironmentsRequest listWorkspaceBaseEnvironmentsRequest) Lists all WorkspaceBaseEnvironments in the workspace.
Operation	refreshWorkspaceBaseEnvironment(RefreshWorkspaceBaseEnvironmentRequest refreshWorkspaceBaseEnvironmentRequest) Refreshes the materialized environment for a WorkspaceBaseEnvironment.
DefaultWorkspaceBaseEnvironment	updateDefaultWorkspaceBaseEnvironment(UpdateDefaultWorkspaceBaseEnvironmentRequest updateDefaultWorkspaceBaseEnvironmentRequest) Updates the default WorkspaceBaseEnvironment configuration for the workspace.
Operation	updateWorkspaceBaseEnvironment(UpdateWorkspaceBaseEnvironmentRequest updateWorkspaceBaseEnvironmentRequest) Updates an existing WorkspaceBaseEnvironment.

Method Detail

createWorkspaceBaseEnvironment

Operation createWorkspaceBaseEnvironment(CreateWorkspaceBaseEnvironmentRequest createWorkspaceBaseEnvironmentRequest)

Creates a new WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously generate a materialized environment to optimize dependency resolution and is only marked as done when the materialized environment has been successfully generated or has failed.

deleteWorkspaceBaseEnvironment

void deleteWorkspaceBaseEnvironment(DeleteWorkspaceBaseEnvironmentRequest deleteWorkspaceBaseEnvironmentRequest)

Deletes a WorkspaceBaseEnvironment. Deleting a base environment may impact linked notebooks and jobs. This operation is irreversible and should be performed only when you are certain the environment is no longer needed.

getDefaultWorkspaceBaseEnvironment

DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment(GetDefaultWorkspaceBaseEnvironmentRequest getDefaultWorkspaceBaseEnvironmentRequest)

Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current default base environment settings for both CPU and GPU compute.

getOperation

Operation getOperation(GetOperationRequest getOperationRequest)

Gets the status of a long-running operation. Clients can use this method to poll the operation result.

getWorkspaceBaseEnvironment

WorkspaceBaseEnvironment getWorkspaceBaseEnvironment(GetWorkspaceBaseEnvironmentRequest getWorkspaceBaseEnvironmentRequest)

Retrieves a WorkspaceBaseEnvironment by its name.

listWorkspaceBaseEnvironments

ListWorkspaceBaseEnvironmentsResponse listWorkspaceBaseEnvironments(ListWorkspaceBaseEnvironmentsRequest listWorkspaceBaseEnvironmentsRequest)

Lists all WorkspaceBaseEnvironments in the workspace.

Databricks provides the following base environments:

- `workspace-base-environments/databricks_ai_...`: includes popular AI and deep learning packages for serverless GPU compute.

- `workspace-base-environments/databricks_ml_...`: includes popular ML packages for serverless compute.

Databricks-provided base environments are versioned. For example, `workspace-base-environments/databricks_ml_v5` corresponds to the ML environment built on environment version 5.

refreshWorkspaceBaseEnvironment

Operation refreshWorkspaceBaseEnvironment(RefreshWorkspaceBaseEnvironmentRequest refreshWorkspaceBaseEnvironmentRequest)

Refreshes the materialized environment for a WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has failed. The existing materialized environment remains available until it expires.

updateDefaultWorkspaceBaseEnvironment

DefaultWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment(UpdateDefaultWorkspaceBaseEnvironmentRequest updateDefaultWorkspaceBaseEnvironmentRequest)

Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the specified base environments as the workspace defaults for CPU and/or GPU compute.

updateWorkspaceBaseEnvironment

Operation updateWorkspaceBaseEnvironment(UpdateWorkspaceBaseEnvironmentRequest updateWorkspaceBaseEnvironmentRequest)

Updates an existing WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has failed. The existing materialized environment remains available until it expires.