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(App app)
Wait<App,App>	create(CreateAppRequest request) Create an app.
App	delete(DeleteAppRequest request) Delete an app.
App	delete(String name)
Wait<AppDeployment,AppDeployment>	deploy(CreateAppDeploymentRequest request) Create an app deployment.
Wait<AppDeployment,AppDeployment>	deploy(String appName, AppDeployment appDeployment)
App	get(GetAppRequest request) Get an app.
App	get(String name)
AppDeployment	getDeployment(GetAppDeploymentRequest request) Get an app deployment.
AppDeployment	getDeployment(String appName, String deploymentId)
GetAppPermissionLevelsResponse	getPermissionLevels(GetAppPermissionLevelsRequest request) Get app permission levels.
GetAppPermissionLevelsResponse	getPermissionLevels(String appName)
AppPermissions	getPermissions(GetAppPermissionsRequest request) Get app permissions.
AppPermissions	getPermissions(String appName)
AppsService	impl()
Iterable<App>	list(ListAppsRequest request) List apps.
Iterable<AppDeployment>	listDeployments(ListAppDeploymentsRequest request) List app deployments.
Iterable<AppDeployment>	listDeployments(String appName)
AppPermissions	setPermissions(AppPermissionsRequest request) Set app permissions.
AppPermissions	setPermissions(String appName)
Wait<App,App>	start(StartAppRequest request) Start an app.
Wait<App,App>	start(String name)
Wait<App,App>	stop(StopAppRequest request) Stop an app.
Wait<App,App>	stop(String name)
App	update(String name, App app)
App	update(UpdateAppRequest request) Update an app.
AppPermissions	updatePermissions(AppPermissionsRequest request) Update app permissions.
AppPermissions	updatePermissions(String appName)
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)

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

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(App app)

create

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

Create an app.

Creates a new app.

delete

public App delete(String name)

delete

public App delete(DeleteAppRequest request)

Delete an app.

Deletes an app.

deploy

public Wait<AppDeployment,AppDeployment> deploy(String appName,
                                                AppDeployment appDeployment)

deploy

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

Create an app deployment.

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

get

public App get(String name)

get

public App get(GetAppRequest request)

Get an app.

Retrieves information for the app with the supplied name.

getDeployment

public AppDeployment getDeployment(String appName,
                                   String deploymentId)

getDeployment

public AppDeployment getDeployment(GetAppDeploymentRequest request)

Get an app deployment.

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)

Get app permission levels.

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

getPermissions

public AppPermissions getPermissions(String appName)

getPermissions

public AppPermissions getPermissions(GetAppPermissionsRequest request)

Get app permissions.

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

list

public Iterable<App> list(ListAppsRequest request)

List apps.

Lists all apps in the workspace.

listDeployments

public Iterable<AppDeployment> listDeployments(String appName)

listDeployments

public Iterable<AppDeployment> listDeployments(ListAppDeploymentsRequest request)

List app deployments.

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

setPermissions

public AppPermissions setPermissions(String appName)

setPermissions

public AppPermissions setPermissions(AppPermissionsRequest request)

Set app 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.

start

public Wait<App,App> start(String name)

start

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

Start an app.

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

stop

public Wait<App,App> stop(String name)

stop

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

Stop an app.

Stops the active deployment of the app in the workspace.

update

public App update(String name,
                  App app)

update

public App update(UpdateAppRequest request)

Update an app.

Updates the app with the supplied name.

updatePermissions

public AppPermissions updatePermissions(String appName)

updatePermissions

public AppPermissions updatePermissions(AppPermissionsRequest request)

Update app permissions.

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

impl

public AppsService impl()