com.databricks.sdk.service.compute

Class InstancePoolsAPI

java.lang.Object

com.databricks.sdk.service.compute.InstancePoolsAPI

@Generated
public class InstancePoolsAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
InstancePoolsAPI(ApiClient apiClient) Regular-use constructor
InstancePoolsAPI(InstancePoolsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CreateInstancePoolResponse	create(CreateInstancePool request) Creates a new instance pool using idle and ready-to-use cloud instances.
void	delete(DeleteInstancePool request) Deletes the instance pool permanently.
void	delete(String instancePoolId)
void	edit(EditInstancePool request) Modifies the configuration of an existing instance pool.
GetInstancePool	get(GetInstancePoolRequest request) Retrieve the information for an instance pool based on its identifier.
GetInstancePool	get(String instancePoolId)
GetInstancePoolPermissionLevelsResponse	getPermissionLevels(GetInstancePoolPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetInstancePoolPermissionLevelsResponse	getPermissionLevels(String instancePoolId)
InstancePoolPermissions	getPermissions(GetInstancePoolPermissionsRequest request) Gets the permissions of an instance pool.
InstancePoolPermissions	getPermissions(String instancePoolId)
InstancePoolsService	impl()
Iterable<InstancePoolAndStats>	list() Gets a list of instance pools with their statistics.
InstancePoolPermissions	setPermissions(InstancePoolPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
InstancePoolPermissions	updatePermissions(InstancePoolPermissionsRequest request) Updates the permissions on an instance pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstancePoolsAPI

public InstancePoolsAPI(ApiClient apiClient)

Regular-use constructor

InstancePoolsAPI

public InstancePoolsAPI(InstancePoolsService mock)

Constructor for mocks

Method Detail

create

public CreateInstancePoolResponse create(CreateInstancePool request)

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

delete

public void delete(String instancePoolId)

delete

public void delete(DeleteInstancePool request)

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

edit

public void edit(EditInstancePool request)

Modifies the configuration of an existing instance pool.

get

public GetInstancePool get(String instancePoolId)

get

public GetInstancePool get(GetInstancePoolRequest request)

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

getPermissionLevels

public GetInstancePoolPermissionLevelsResponse getPermissionLevels(String instancePoolId)

getPermissionLevels

public GetInstancePoolPermissionLevelsResponse getPermissionLevels(GetInstancePoolPermissionLevelsRequest request)

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

getPermissions

public InstancePoolPermissions getPermissions(String instancePoolId)

getPermissions

public InstancePoolPermissions getPermissions(GetInstancePoolPermissionsRequest request)

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

list

public Iterable<InstancePoolAndStats> list()

Gets a list of instance pools with their statistics.

setPermissions

public InstancePoolPermissions setPermissions(InstancePoolPermissionsRequest request)

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

updatePermissions

public InstancePoolPermissions updatePermissions(InstancePoolPermissionsRequest request)

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

impl

public InstancePoolsService impl()