com.databricks.sdk.service.compute

Interface InstancePoolsService

@Generated
public interface InstancePoolsService

Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use cloud instances which reduces a cluster start and auto-scaling times.

Databricks pools reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances. When a cluster is attached to a pool, cluster nodes are created using the pool’s idle instances. If the pool has no idle instances, the pool expands by allocating a new instance from the instance provider in order to accommodate the cluster’s request. When a cluster releases an instance, it returns to the pool and is free for another cluster to use. Only clusters attached to a pool can use that pool’s idle instances.

You can specify a different pool for the driver node and worker nodes, or use the same pool for both.

Databricks does not charge DBUs while instances are idle in the pool. Instance provider billing does apply. See pricing.

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
CreateInstancePoolResponse	create(CreateInstancePool createInstancePool) Create a new instance pool.
void	delete(DeleteInstancePool deleteInstancePool) Delete an instance pool.
void	edit(EditInstancePool editInstancePool) Edit an existing instance pool.
GetInstancePool	get(GetInstancePoolRequest getInstancePoolRequest) Get instance pool information.
GetInstancePoolPermissionLevelsResponse	getPermissionLevels(GetInstancePoolPermissionLevelsRequest getInstancePoolPermissionLevelsRequest) Get instance pool permission levels.
InstancePoolPermissions	getPermissions(GetInstancePoolPermissionsRequest getInstancePoolPermissionsRequest) Get instance pool permissions.
ListInstancePools	list() List instance pool info.
InstancePoolPermissions	setPermissions(InstancePoolPermissionsRequest instancePoolPermissionsRequest) Set instance pool permissions.
InstancePoolPermissions	updatePermissions(InstancePoolPermissionsRequest instancePoolPermissionsRequest) Update instance pool permissions.

Method Detail

create

CreateInstancePoolResponse create(CreateInstancePool createInstancePool)

Create a new instance pool.

Creates a new instance pool using idle and ready-to-use cloud instances.

delete

void delete(DeleteInstancePool deleteInstancePool)

Delete an instance pool.

Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously.

edit

void edit(EditInstancePool editInstancePool)

Edit an existing instance pool.

Modifies the configuration of an existing instance pool.

get

GetInstancePool get(GetInstancePoolRequest getInstancePoolRequest)

Get instance pool information.

Retrieve the information for an instance pool based on its identifier.

getPermissionLevels

GetInstancePoolPermissionLevelsResponse getPermissionLevels(GetInstancePoolPermissionLevelsRequest getInstancePoolPermissionLevelsRequest)

Get instance pool permission levels.

Gets the permission levels that a user can have on an object.

getPermissions

InstancePoolPermissions getPermissions(GetInstancePoolPermissionsRequest getInstancePoolPermissionsRequest)

Get instance pool permissions.

Gets the permissions of an instance pool. Instance pools can inherit permissions from their root object.

list

ListInstancePools list()

List instance pool info.

Gets a list of instance pools with their statistics.

setPermissions

InstancePoolPermissions setPermissions(InstancePoolPermissionsRequest instancePoolPermissionsRequest)

Set instance pool permissions.

Sets permissions on an instance pool. Instance pools can inherit permissions from their root object.

updatePermissions

InstancePoolPermissions updatePermissions(InstancePoolPermissionsRequest instancePoolPermissionsRequest)

Update instance pool permissions.

Updates the permissions on an instance pool. Instance pools can inherit permissions from their root object.