com.databricks.sdk.service.sql

Class WarehousesAPI

java.lang.Object

com.databricks.sdk.service.sql.WarehousesAPI

@Generated
public class WarehousesAPI
extends Object

A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL. Compute resources are infrastructure resources that provide processing capabilities in the cloud.

Constructor Summary

Constructors

Constructor and Description
WarehousesAPI(ApiClient apiClient) Regular-use constructor
WarehousesAPI(WarehousesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Wait<GetWarehouseResponse,CreateWarehouseResponse>	create(CreateWarehouseRequest request) Create a warehouse.
void	delete(DeleteWarehouseRequest request) Delete a warehouse.
void	delete(String id)
Wait<GetWarehouseResponse,Void>	edit(EditWarehouseRequest request) Update a warehouse.
Wait<GetWarehouseResponse,Void>	edit(String id)
GetWarehouseResponse	get(GetWarehouseRequest request) Get warehouse info.
GetWarehouseResponse	get(String id)
GetWarehousePermissionLevelsResponse	getPermissionLevels(GetWarehousePermissionLevelsRequest request) Get SQL warehouse permission levels.
GetWarehousePermissionLevelsResponse	getPermissionLevels(String warehouseId)
WarehousePermissions	getPermissions(GetWarehousePermissionsRequest request) Get SQL warehouse permissions.
WarehousePermissions	getPermissions(String warehouseId)
GetWorkspaceWarehouseConfigResponse	getWorkspaceWarehouseConfig() Get the workspace configuration.
WarehousesService	impl()
Iterable<EndpointInfo>	list(ListWarehousesRequest request) List warehouses.
WarehousePermissions	setPermissions(String warehouseId)
WarehousePermissions	setPermissions(WarehousePermissionsRequest request) Set SQL warehouse permissions.
void	setWorkspaceWarehouseConfig(SetWorkspaceWarehouseConfigRequest request) Set the workspace configuration.
Wait<GetWarehouseResponse,Void>	start(StartRequest request) Start a warehouse.
Wait<GetWarehouseResponse,Void>	start(String id)
Wait<GetWarehouseResponse,Void>	stop(StopRequest request) Stop a warehouse.
Wait<GetWarehouseResponse,Void>	stop(String id)
WarehousePermissions	updatePermissions(String warehouseId)
WarehousePermissions	updatePermissions(WarehousePermissionsRequest request) Update SQL warehouse permissions.
GetWarehouseResponse	waitGetWarehouseRunning(String id)
GetWarehouseResponse	waitGetWarehouseRunning(String id, Duration timeout, Consumer<GetWarehouseResponse> callback)
GetWarehouseResponse	waitGetWarehouseStopped(String id)
GetWarehouseResponse	waitGetWarehouseStopped(String id, Duration timeout, Consumer<GetWarehouseResponse> callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

WarehousesAPI

public WarehousesAPI(ApiClient apiClient)

Regular-use constructor

WarehousesAPI

public WarehousesAPI(WarehousesService mock)

Constructor for mocks

Method Detail

waitGetWarehouseRunning

public GetWarehouseResponse waitGetWarehouseRunning(String id)
                                             throws TimeoutException

Throws:

TimeoutException

waitGetWarehouseRunning

public GetWarehouseResponse waitGetWarehouseRunning(String id,
                                                    Duration timeout,
                                                    Consumer<GetWarehouseResponse> callback)
                                             throws TimeoutException

Throws:

TimeoutException

waitGetWarehouseStopped

public GetWarehouseResponse waitGetWarehouseStopped(String id)
                                             throws TimeoutException

Throws:

TimeoutException

waitGetWarehouseStopped

public GetWarehouseResponse waitGetWarehouseStopped(String id,
                                                    Duration timeout,
                                                    Consumer<GetWarehouseResponse> callback)
                                             throws TimeoutException

Throws:

TimeoutException

create

public Wait<GetWarehouseResponse,CreateWarehouseResponse> create(CreateWarehouseRequest request)

Create a warehouse.

Creates a new SQL warehouse.

delete

public void delete(String id)

delete

public void delete(DeleteWarehouseRequest request)

Delete a warehouse.

Deletes a SQL warehouse.

edit

public Wait<GetWarehouseResponse,Void> edit(String id)

edit

public Wait<GetWarehouseResponse,Void> edit(EditWarehouseRequest request)

Update a warehouse.

Updates the configuration for a SQL warehouse.

get

public GetWarehouseResponse get(String id)

get

public GetWarehouseResponse get(GetWarehouseRequest request)

Get warehouse info.

Gets the information for a single SQL warehouse.

getPermissionLevels

public GetWarehousePermissionLevelsResponse getPermissionLevels(String warehouseId)

getPermissionLevels

public GetWarehousePermissionLevelsResponse getPermissionLevels(GetWarehousePermissionLevelsRequest request)

Get SQL warehouse permission levels.

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

getPermissions

public WarehousePermissions getPermissions(String warehouseId)

getPermissions

public WarehousePermissions getPermissions(GetWarehousePermissionsRequest request)

Get SQL warehouse permissions.

Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root object.

getWorkspaceWarehouseConfig

public GetWorkspaceWarehouseConfigResponse getWorkspaceWarehouseConfig()

Get the workspace configuration.

Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.

list

public Iterable<EndpointInfo> list(ListWarehousesRequest request)

List warehouses.

Lists all SQL warehouses that a user has manager permissions on.

setPermissions

public WarehousePermissions setPermissions(String warehouseId)

setPermissions

public WarehousePermissions setPermissions(WarehousePermissionsRequest request)

Set SQL warehouse permissions.

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.

setWorkspaceWarehouseConfig

public void setWorkspaceWarehouseConfig(SetWorkspaceWarehouseConfigRequest request)

Set the workspace configuration.

Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.

start

public Wait<GetWarehouseResponse,Void> start(String id)

start

public Wait<GetWarehouseResponse,Void> start(StartRequest request)

Start a warehouse.

Starts a SQL warehouse.

stop

public Wait<GetWarehouseResponse,Void> stop(String id)

stop

public Wait<GetWarehouseResponse,Void> stop(StopRequest request)

Stop a warehouse.

Stops a SQL warehouse.

updatePermissions

public WarehousePermissions updatePermissions(String warehouseId)

updatePermissions

public WarehousePermissions updatePermissions(WarehousePermissionsRequest request)

Update SQL warehouse permissions.

Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root object.

impl

public WarehousesService impl()