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) Creates a new SQL warehouse.
DefaultWarehouseOverride	createDefaultWarehouseOverride(CreateDefaultWarehouseOverrideRequest request) Creates a new default warehouse override for a user.
void	delete(DeleteWarehouseRequest request) Deletes a SQL warehouse.
void	delete(String id)
void	deleteDefaultWarehouseOverride(DeleteDefaultWarehouseOverrideRequest request) Deletes the default warehouse override for a user.
void	deleteDefaultWarehouseOverride(String name)
Wait<GetWarehouseResponse,Void>	edit(EditWarehouseRequest request) Updates the configuration for a SQL warehouse.
GetWarehouseResponse	get(GetWarehouseRequest request) Gets the information for a single SQL warehouse.
GetWarehouseResponse	get(String id)
DefaultWarehouseOverride	getDefaultWarehouseOverride(GetDefaultWarehouseOverrideRequest request) Returns the default warehouse override for a user.
DefaultWarehouseOverride	getDefaultWarehouseOverride(String name)
GetWarehousePermissionLevelsResponse	getPermissionLevels(GetWarehousePermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetWarehousePermissionLevelsResponse	getPermissionLevels(String warehouseId)
WarehousePermissions	getPermissions(GetWarehousePermissionsRequest request) Gets the permissions of a SQL warehouse.
WarehousePermissions	getPermissions(String warehouseId)
GetWorkspaceWarehouseConfigResponse	getWorkspaceWarehouseConfig() Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.
WarehousesService	impl()
Iterable<EndpointInfo>	list(ListWarehousesRequest request) Lists all SQL warehouses that a user has access to.
Iterable<DefaultWarehouseOverride>	listDefaultWarehouseOverrides(ListDefaultWarehouseOverridesRequest request) Lists all default warehouse overrides in the workspace.
WarehousePermissions	setPermissions(WarehousePermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
void	setWorkspaceWarehouseConfig(SetWorkspaceWarehouseConfigRequest request) Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.
Wait<GetWarehouseResponse,Void>	start(StartRequest request) Starts a SQL warehouse.
Wait<GetWarehouseResponse,Void>	stop(StopRequest request) Stops a SQL warehouse.
DefaultWarehouseOverride	updateDefaultWarehouseOverride(UpdateDefaultWarehouseOverrideRequest request) Updates an existing default warehouse override for a user.
WarehousePermissions	updatePermissions(WarehousePermissionsRequest request) Updates the permissions on a SQL warehouse.
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)

Creates a new SQL warehouse.

createDefaultWarehouseOverride

public DefaultWarehouseOverride createDefaultWarehouseOverride(CreateDefaultWarehouseOverrideRequest request)

Creates a new default warehouse override for a user. Users can create their own override. Admins can create overrides for any user.

delete

public void delete(String id)

delete

public void delete(DeleteWarehouseRequest request)

Deletes a SQL warehouse.

deleteDefaultWarehouseOverride

public void deleteDefaultWarehouseOverride(String name)

deleteDefaultWarehouseOverride

public void deleteDefaultWarehouseOverride(DeleteDefaultWarehouseOverrideRequest request)

Deletes the default warehouse override for a user. Users can delete their own override. Admins can delete overrides for any user. After deletion, the workspace default warehouse will be used.

edit

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

Updates the configuration for a SQL warehouse.

get

public GetWarehouseResponse get(String id)

get

public GetWarehouseResponse get(GetWarehouseRequest request)

Gets the information for a single SQL warehouse.

getDefaultWarehouseOverride

public DefaultWarehouseOverride getDefaultWarehouseOverride(String name)

getDefaultWarehouseOverride

public DefaultWarehouseOverride getDefaultWarehouseOverride(GetDefaultWarehouseOverrideRequest request)

Returns the default warehouse override for a user. Users can fetch their own override. Admins can fetch overrides for any user. If no override exists, the UI will fallback to the workspace default warehouse.

getPermissionLevels

public GetWarehousePermissionLevelsResponse getPermissionLevels(String warehouseId)

getPermissionLevels

public GetWarehousePermissionLevelsResponse getPermissionLevels(GetWarehousePermissionLevelsRequest request)

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

getPermissions

public WarehousePermissions getPermissions(String warehouseId)

getPermissions

public WarehousePermissions getPermissions(GetWarehousePermissionsRequest request)

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

getWorkspaceWarehouseConfig

public GetWorkspaceWarehouseConfigResponse getWorkspaceWarehouseConfig()

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

list

public Iterable<EndpointInfo> list(ListWarehousesRequest request)

Lists all SQL warehouses that a user has access to.

listDefaultWarehouseOverrides

public Iterable<DefaultWarehouseOverride> listDefaultWarehouseOverrides(ListDefaultWarehouseOverridesRequest request)

Lists all default warehouse overrides in the workspace. Only workspace administrators can list all overrides.

setPermissions

public WarehousePermissions setPermissions(WarehousePermissionsRequest 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.

setWorkspaceWarehouseConfig

public void setWorkspaceWarehouseConfig(SetWorkspaceWarehouseConfigRequest request)

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

start

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

Starts a SQL warehouse.

stop

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

Stops a SQL warehouse.

updateDefaultWarehouseOverride

public DefaultWarehouseOverride updateDefaultWarehouseOverride(UpdateDefaultWarehouseOverrideRequest request)

Updates an existing default warehouse override for a user. Users can update their own override. Admins can update overrides for any user.

updatePermissions

public WarehousePermissions updatePermissions(WarehousePermissionsRequest request)

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

impl

public WarehousesService impl()