com.databricks.sdk.service.environments

Class EnvironmentsAPI

java.lang.Object

com.databricks.sdk.service.environments.EnvironmentsAPI

@Generated
public class EnvironmentsAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
EnvironmentsAPI(ApiClient apiClient) Regular-use constructor
EnvironmentsAPI(EnvironmentsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CreateWorkspaceBaseEnvironmentOperation	createWorkspaceBaseEnvironment(CreateWorkspaceBaseEnvironmentRequest request) Creates a new WorkspaceBaseEnvironment.
void	deleteWorkspaceBaseEnvironment(DeleteWorkspaceBaseEnvironmentRequest request) Deletes a WorkspaceBaseEnvironment.
void	deleteWorkspaceBaseEnvironment(String name)
DefaultWorkspaceBaseEnvironment	getDefaultWorkspaceBaseEnvironment(GetDefaultWorkspaceBaseEnvironmentRequest request) Gets the default WorkspaceBaseEnvironment configuration for the workspace.
DefaultWorkspaceBaseEnvironment	getDefaultWorkspaceBaseEnvironment(String name)
Operation	getOperation(GetOperationRequest request) Gets the status of a long-running operation.
Operation	getOperation(String name)
WorkspaceBaseEnvironment	getWorkspaceBaseEnvironment(GetWorkspaceBaseEnvironmentRequest request) Retrieves a WorkspaceBaseEnvironment by its name.
WorkspaceBaseEnvironment	getWorkspaceBaseEnvironment(String name)
EnvironmentsService	impl()
Iterable<WorkspaceBaseEnvironment>	listWorkspaceBaseEnvironments(ListWorkspaceBaseEnvironmentsRequest request) Lists all WorkspaceBaseEnvironments in the workspace.
RefreshWorkspaceBaseEnvironmentOperation	refreshWorkspaceBaseEnvironment(RefreshWorkspaceBaseEnvironmentRequest request) Refreshes the materialized environment for a WorkspaceBaseEnvironment.
DefaultWorkspaceBaseEnvironment	updateDefaultWorkspaceBaseEnvironment(UpdateDefaultWorkspaceBaseEnvironmentRequest request) Updates the default WorkspaceBaseEnvironment configuration for the workspace.
UpdateWorkspaceBaseEnvironmentOperation	updateWorkspaceBaseEnvironment(UpdateWorkspaceBaseEnvironmentRequest request) Updates an existing WorkspaceBaseEnvironment.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentsAPI

public EnvironmentsAPI(ApiClient apiClient)

Regular-use constructor

EnvironmentsAPI

public EnvironmentsAPI(EnvironmentsService mock)

Constructor for mocks

Method Detail

createWorkspaceBaseEnvironment

public CreateWorkspaceBaseEnvironmentOperation createWorkspaceBaseEnvironment(CreateWorkspaceBaseEnvironmentRequest request)

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

public void deleteWorkspaceBaseEnvironment(String name)

deleteWorkspaceBaseEnvironment

public void deleteWorkspaceBaseEnvironment(DeleteWorkspaceBaseEnvironmentRequest request)

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

public DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment(String name)

getDefaultWorkspaceBaseEnvironment

public DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment(GetDefaultWorkspaceBaseEnvironmentRequest request)

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

getOperation

public Operation getOperation(String name)

getOperation

public Operation getOperation(GetOperationRequest request)

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

getWorkspaceBaseEnvironment

public WorkspaceBaseEnvironment getWorkspaceBaseEnvironment(String name)

getWorkspaceBaseEnvironment

public WorkspaceBaseEnvironment getWorkspaceBaseEnvironment(GetWorkspaceBaseEnvironmentRequest request)

Retrieves a WorkspaceBaseEnvironment by its name.

listWorkspaceBaseEnvironments

public Iterable<WorkspaceBaseEnvironment> listWorkspaceBaseEnvironments(ListWorkspaceBaseEnvironmentsRequest request)

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

public RefreshWorkspaceBaseEnvironmentOperation refreshWorkspaceBaseEnvironment(RefreshWorkspaceBaseEnvironmentRequest request)

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

public DefaultWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment(UpdateDefaultWorkspaceBaseEnvironmentRequest request)

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

updateWorkspaceBaseEnvironment

public UpdateWorkspaceBaseEnvironmentOperation updateWorkspaceBaseEnvironment(UpdateWorkspaceBaseEnvironmentRequest request)

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.

impl

public EnvironmentsService impl()