com.databricks.sdk.service.apps

Class AppsAPI

java.lang.Object

com.databricks.sdk.service.apps.AppsAPI

@Generated
public class AppsAPI
extends Object

Apps run directly on a customer's Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on.

Constructor Summary

Constructors

Constructor and Description
AppsAPI(ApiClient apiClient) Regular-use constructor
AppsAPI(AppsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Wait<App,App>	create(CreateAppRequest request) Creates a new app.
CreateSpaceOperation	createSpace(CreateSpaceRequest request) Creates a new app space.
Wait<AppUpdate,AppUpdate>	createUpdate(AsyncUpdateAppRequest request) Creates an app update and starts the update process.
App	delete(DeleteAppRequest request) Deletes an app.
App	delete(String name)
void	deleteAppThumbnail(DeleteAppThumbnailRequest request) Deletes the thumbnail for an app.
void	deleteAppThumbnail(String name)
DeleteSpaceOperation	deleteSpace(DeleteSpaceRequest request) Deletes an app space.
DeleteSpaceOperation	deleteSpace(String name)
Wait<AppDeployment,AppDeployment>	deploy(CreateAppDeploymentRequest request) Creates an app deployment for the app with the supplied name.
App	get(GetAppRequest request) Retrieves information for the app with the supplied name.
App	get(String name)
AppDeployment	getDeployment(GetAppDeploymentRequest request) Retrieves information for the app deployment with the supplied name and deployment id.
AppDeployment	getDeployment(String appName, String deploymentId)
GetAppPermissionLevelsResponse	getPermissionLevels(GetAppPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetAppPermissionLevelsResponse	getPermissionLevels(String appName)
AppPermissions	getPermissions(GetAppPermissionsRequest request) Gets the permissions of an app.
AppPermissions	getPermissions(String appName)
Space	getSpace(GetSpaceRequest request) Retrieves information for the app space with the supplied name.
Space	getSpace(String name)
Operation	getSpaceOperation(GetOperationRequest request) Gets the status of an app space update operation.
Operation	getSpaceOperation(String name)
AppUpdate	getUpdate(GetAppUpdateRequest request) Gets the status of an app update.
AppUpdate	getUpdate(String appName)
AppsService	impl()
Iterable<App>	list(ListAppsRequest request) Lists all apps in the workspace.
Iterable<AppDeployment>	listDeployments(ListAppDeploymentsRequest request) Lists all app deployments for the app with the supplied name.
Iterable<AppDeployment>	listDeployments(String appName)
Iterable<Space>	listSpaces(ListSpacesRequest request) Lists all app spaces in the workspace.
AppPermissions	setPermissions(AppPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
Wait<App,App>	start(StartAppRequest request) Start the last active deployment of the app in the workspace.
Wait<App,App>	stop(StopAppRequest request) Stops the active deployment of the app in the workspace.
App	update(UpdateAppRequest request) Updates the app with the supplied name.
AppThumbnail	updateAppThumbnail(UpdateAppThumbnailRequest request) Updates the thumbnail for an app.
AppPermissions	updatePermissions(AppPermissionsRequest request) Updates the permissions on an app.
UpdateSpaceOperation	updateSpace(UpdateSpaceRequest request) Updates an app space.
App	waitGetAppActive(String name)
App	waitGetAppActive(String name, Duration timeout, Consumer<App> callback)
App	waitGetAppStopped(String name)
App	waitGetAppStopped(String name, Duration timeout, Consumer<App> callback)
AppDeployment	waitGetDeploymentAppSucceeded(String appName, String deploymentId)
AppDeployment	waitGetDeploymentAppSucceeded(String appName, String deploymentId, Duration timeout, Consumer<AppDeployment> callback)
AppUpdate	waitGetUpdateAppSucceeded(String appName)
AppUpdate	waitGetUpdateAppSucceeded(String appName, Duration timeout, Consumer<AppUpdate> callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

AppsAPI

public AppsAPI(ApiClient apiClient)

Regular-use constructor

AppsAPI

public AppsAPI(AppsService mock)

Constructor for mocks

Method Detail

waitGetAppActive

public App waitGetAppActive(String name)
                     throws TimeoutException

Throws:

TimeoutException

waitGetAppActive

public App waitGetAppActive(String name,
                            Duration timeout,
                            Consumer<App> callback)
                     throws TimeoutException

Throws:

TimeoutException

waitGetUpdateAppSucceeded

public AppUpdate waitGetUpdateAppSucceeded(String appName)
                                    throws TimeoutException

Throws:

TimeoutException

waitGetUpdateAppSucceeded

public AppUpdate waitGetUpdateAppSucceeded(String appName,
                                           Duration timeout,
                                           Consumer<AppUpdate> callback)
                                    throws TimeoutException

Throws:

TimeoutException

waitGetDeploymentAppSucceeded

public AppDeployment waitGetDeploymentAppSucceeded(String appName,
                                                   String deploymentId)
                                            throws TimeoutException

Throws:

TimeoutException

waitGetDeploymentAppSucceeded

public AppDeployment waitGetDeploymentAppSucceeded(String appName,
                                                   String deploymentId,
                                                   Duration timeout,
                                                   Consumer<AppDeployment> callback)
                                            throws TimeoutException

Throws:

TimeoutException

waitGetAppStopped

public App waitGetAppStopped(String name)
                      throws TimeoutException

Throws:

TimeoutException

waitGetAppStopped

public App waitGetAppStopped(String name,
                             Duration timeout,
                             Consumer<App> callback)
                      throws TimeoutException

Throws:

TimeoutException

create

public Wait<App,App> create(CreateAppRequest request)

Creates a new app.

createSpace

public CreateSpaceOperation createSpace(CreateSpaceRequest request)

Creates a new app space.

createUpdate

public Wait<AppUpdate,AppUpdate> createUpdate(AsyncUpdateAppRequest request)

Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method.

delete

public App delete(String name)

delete

public App delete(DeleteAppRequest request)

Deletes an app.

deleteAppThumbnail

public void deleteAppThumbnail(String name)

deleteAppThumbnail

public void deleteAppThumbnail(DeleteAppThumbnailRequest request)

Deletes the thumbnail for an app.

deleteSpace

public DeleteSpaceOperation deleteSpace(String name)

deleteSpace

public DeleteSpaceOperation deleteSpace(DeleteSpaceRequest request)

Deletes an app space.

deploy

public Wait<AppDeployment,AppDeployment> deploy(CreateAppDeploymentRequest request)

Creates an app deployment for the app with the supplied name.

get

public App get(String name)

get

public App get(GetAppRequest request)

Retrieves information for the app with the supplied name.

getDeployment

public AppDeployment getDeployment(String appName,
                                   String deploymentId)

getDeployment

public AppDeployment getDeployment(GetAppDeploymentRequest request)

Retrieves information for the app deployment with the supplied name and deployment id.

getPermissionLevels

public GetAppPermissionLevelsResponse getPermissionLevels(String appName)

getPermissionLevels

public GetAppPermissionLevelsResponse getPermissionLevels(GetAppPermissionLevelsRequest request)

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

getPermissions

public AppPermissions getPermissions(String appName)

getPermissions

public AppPermissions getPermissions(GetAppPermissionsRequest request)

Gets the permissions of an app. Apps can inherit permissions from their root object.

getSpace

public Space getSpace(String name)

getSpace

public Space getSpace(GetSpaceRequest request)

Retrieves information for the app space with the supplied name.

getSpaceOperation

public Operation getSpaceOperation(String name)

getSpaceOperation

public Operation getSpaceOperation(GetOperationRequest request)

Gets the status of an app space update operation.

getUpdate

public AppUpdate getUpdate(String appName)

getUpdate

public AppUpdate getUpdate(GetAppUpdateRequest request)

Gets the status of an app update.

list

public Iterable<App> list(ListAppsRequest request)

Lists all apps in the workspace.

listDeployments

public Iterable<AppDeployment> listDeployments(String appName)

listDeployments

public Iterable<AppDeployment> listDeployments(ListAppDeploymentsRequest request)

Lists all app deployments for the app with the supplied name.

listSpaces

public Iterable<Space> listSpaces(ListSpacesRequest request)

Lists all app spaces in the workspace.

setPermissions

public AppPermissions setPermissions(AppPermissionsRequest 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.

start

public Wait<App,App> start(StartAppRequest request)

Start the last active deployment of the app in the workspace.

stop

public Wait<App,App> stop(StopAppRequest request)

Stops the active deployment of the app in the workspace.

update

public App update(UpdateAppRequest request)

Updates the app with the supplied name.

updateAppThumbnail

public AppThumbnail updateAppThumbnail(UpdateAppThumbnailRequest request)

Updates the thumbnail for an app.

updatePermissions

public AppPermissions updatePermissions(AppPermissionsRequest request)

Updates the permissions on an app. Apps can inherit permissions from their root object.

updateSpace

public UpdateSpaceOperation updateSpace(UpdateSpaceRequest request)

Updates an app space. The update process is asynchronous and the status of the update can be checked with the GetSpaceOperation method.

impl

public AppsService impl()