Class EnvironmentsClient

Index

Constructors

Methods

createWorkspaceBaseEnvironment deleteWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment getWorkspaceBaseEnvironment listWorkspaceBaseEnvironments listWorkspaceBaseEnvironmentsIter refreshWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment updateWorkspaceBaseEnvironment

Constructors

constructor

new EnvironmentsClient(options: ClientOptions): EnvironmentsClient
Parameters
- options: ClientOptions
Returns EnvironmentsClient
- Defined in client.ts:68

Methods

createWorkspaceBaseEnvironment

createWorkspaceBaseEnvironment(
req: CreateWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<CreateWorkspaceBaseEnvironmentOperation>
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.
Parameters
- req: CreateWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<CreateWorkspaceBaseEnvironmentOperation>
- Defined in client.ts:145

deleteWorkspaceBaseEnvironment

deleteWorkspaceBaseEnvironment(
req: DeleteWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<void>
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.
Parameters
- req: DeleteWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:160

getDefaultWorkspaceBaseEnvironment

getDefaultWorkspaceBaseEnvironment(
req: GetDefaultWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<DefaultWorkspaceBaseEnvironment>
Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current default base environment settings for both CPU and GPU compute.
Parameters
- req: GetDefaultWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<DefaultWorkspaceBaseEnvironment>
- Defined in client.ts:186

getWorkspaceBaseEnvironment

getWorkspaceBaseEnvironment(
req: GetWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<WorkspaceBaseEnvironment>
Retrieves a WorkspaceBaseEnvironment by its name.
Parameters
- req: GetWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<WorkspaceBaseEnvironment>
- Defined in client.ts:250

listWorkspaceBaseEnvironments

listWorkspaceBaseEnvironments(
req: ListWorkspaceBaseEnvironmentsRequest,
options?: CallOptions,
): Promise<ListWorkspaceBaseEnvironmentsResponse>
Lists all WorkspaceBaseEnvironments in the workspace.

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.
Parameters
- req: ListWorkspaceBaseEnvironmentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListWorkspaceBaseEnvironmentsResponse>
- Defined in client.ts:294

listWorkspaceBaseEnvironmentsIter

listWorkspaceBaseEnvironmentsIter(
req: ListWorkspaceBaseEnvironmentsRequest,
options?: CallOptions,
): AsyncGenerator<WorkspaceBaseEnvironment>
Parameters
- req: ListWorkspaceBaseEnvironmentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<WorkspaceBaseEnvironment>
- Defined in client.ts:334

refreshWorkspaceBaseEnvironment

refreshWorkspaceBaseEnvironment(
req: RefreshWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<RefreshWorkspaceBaseEnvironmentOperation>
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.
Parameters
- req: RefreshWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<RefreshWorkspaceBaseEnvironmentOperation>
- Defined in client.ts:395

updateDefaultWorkspaceBaseEnvironment

updateDefaultWorkspaceBaseEnvironment(
req: UpdateDefaultWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<DefaultWorkspaceBaseEnvironment>
Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the specified base environments as the workspace defaults for CPU and/or GPU compute.
Parameters
- req: UpdateDefaultWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<DefaultWorkspaceBaseEnvironment>
- Defined in client.ts:409

updateWorkspaceBaseEnvironment

updateWorkspaceBaseEnvironment(
req: UpdateWorkspaceBaseEnvironmentRequest,
options?: CallOptions,
): Promise<UpdateWorkspaceBaseEnvironmentOperation>
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.
Parameters
- req: UpdateWorkspaceBaseEnvironmentRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateWorkspaceBaseEnvironmentOperation>
- Defined in client.ts:500

Class EnvironmentsClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EnvironmentsClient

Methods

createWorkspaceBaseEnvironment

Parameters

Returns Promise<CreateWorkspaceBaseEnvironmentOperation>

deleteWorkspaceBaseEnvironment

Parameters

Returns Promise<void>

getDefaultWorkspaceBaseEnvironment

Parameters

Returns Promise<DefaultWorkspaceBaseEnvironment>

getWorkspaceBaseEnvironment

Parameters

Returns Promise<WorkspaceBaseEnvironment>

listWorkspaceBaseEnvironments

Parameters

Returns Promise<ListWorkspaceBaseEnvironmentsResponse>

listWorkspaceBaseEnvironmentsIter

Parameters

Returns AsyncGenerator<WorkspaceBaseEnvironment>

refreshWorkspaceBaseEnvironment

Parameters

Returns Promise<RefreshWorkspaceBaseEnvironmentOperation>

updateDefaultWorkspaceBaseEnvironment

Parameters

Returns Promise<DefaultWorkspaceBaseEnvironment>

updateWorkspaceBaseEnvironment

Parameters

Returns Promise<UpdateWorkspaceBaseEnvironmentOperation>

Settings

On This Page