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) Create a new instance pool.
CreateInstancePoolResponse	create(String instancePoolName, String nodeTypeId)
void	delete(DeleteInstancePool request) Delete an instance pool.
void	delete(String instancePoolId)
void	edit(EditInstancePool request) Edit an existing instance pool.
void	edit(String instancePoolId, String instancePoolName, String nodeTypeId)
GetInstancePool	get(GetInstancePoolRequest request) Get instance pool information.
GetInstancePool	get(String instancePoolId)
GetInstancePoolPermissionLevelsResponse	getInstancePoolPermissionLevels(GetInstancePoolPermissionLevelsRequest request) Get instance pool permission levels.
GetInstancePoolPermissionLevelsResponse	getInstancePoolPermissionLevels(String instancePoolId)
InstancePoolPermissions	getInstancePoolPermissions(GetInstancePoolPermissionsRequest request) Get instance pool permissions.
InstancePoolPermissions	getInstancePoolPermissions(String instancePoolId)
InstancePoolsService	impl()
Iterable<InstancePoolAndStats>	list() List instance pool info.
InstancePoolPermissions	setInstancePoolPermissions(InstancePoolPermissionsRequest request) Set instance pool permissions.
InstancePoolPermissions	setInstancePoolPermissions(String instancePoolId)
InstancePoolPermissions	updateInstancePoolPermissions(InstancePoolPermissionsRequest request) Update instance pool permissions.
InstancePoolPermissions	updateInstancePoolPermissions(String instancePoolId)

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(String instancePoolName,
                                         String nodeTypeId)

create

public CreateInstancePoolResponse create(CreateInstancePool request)

Create a new instance pool.

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)

Delete an instance pool.

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

edit

public void edit(String instancePoolId,
                 String instancePoolName,
                 String nodeTypeId)

edit

public void edit(EditInstancePool request)

Edit an existing instance pool.

Modifies the configuration of an existing instance pool.

get

public GetInstancePool get(String instancePoolId)

get

public GetInstancePool get(GetInstancePoolRequest request)

Get instance pool information.

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

getInstancePoolPermissionLevels

public GetInstancePoolPermissionLevelsResponse getInstancePoolPermissionLevels(String instancePoolId)

getInstancePoolPermissionLevels

public GetInstancePoolPermissionLevelsResponse getInstancePoolPermissionLevels(GetInstancePoolPermissionLevelsRequest request)

Get instance pool permission levels.

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

getInstancePoolPermissions

public InstancePoolPermissions getInstancePoolPermissions(String instancePoolId)

getInstancePoolPermissions

public InstancePoolPermissions getInstancePoolPermissions(GetInstancePoolPermissionsRequest request)

Get instance pool permissions.

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

list

public Iterable<InstancePoolAndStats> list()

List instance pool info.

Gets a list of instance pools with their statistics.

setInstancePoolPermissions

public InstancePoolPermissions setInstancePoolPermissions(String instancePoolId)

setInstancePoolPermissions

public InstancePoolPermissions setInstancePoolPermissions(InstancePoolPermissionsRequest request)

Set instance pool permissions.

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

updateInstancePoolPermissions

public InstancePoolPermissions updateInstancePoolPermissions(String instancePoolId)

updateInstancePoolPermissions

public InstancePoolPermissions updateInstancePoolPermissions(InstancePoolPermissionsRequest request)

Update instance pool permissions.

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

impl

public InstancePoolsService impl()