com.databricks.sdk.service.sql

Class DbsqlPermissionsAPI

java.lang.Object

com.databricks.sdk.service.sql.DbsqlPermissionsAPI

@Generated
public class DbsqlPermissionsAPI
extends Object

The SQL Permissions API is similar to the endpoints of the :method:permissions/set. However, this exposes only one endpoint, which gets the Access Control List for a given object. You cannot modify any permissions using this API.

There are three levels of permission:

- `CAN_VIEW`: Allows read-only access

- `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`)

- `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify permissions (superset of `CAN_RUN`)

**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

Constructor Summary

Constructors

Constructor and Description
DbsqlPermissionsAPI(ApiClient apiClient) Regular-use constructor
DbsqlPermissionsAPI(DbsqlPermissionsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
GetResponse	get(GetDbsqlPermissionRequest request) Gets a JSON representation of the access control list (ACL) for a specified object.
GetResponse	get(ObjectTypePlural objectType, String objectId)
DbsqlPermissionsService	impl()
SetResponse	set(SetRequest request) Sets the access control list (ACL) for a specified object.
Success	transferOwnership(TransferOwnershipRequest request) Transfers ownership of a dashboard, query, or alert to an active user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbsqlPermissionsAPI

public DbsqlPermissionsAPI(ApiClient apiClient)

Regular-use constructor

DbsqlPermissionsAPI

public DbsqlPermissionsAPI(DbsqlPermissionsService mock)

Constructor for mocks

Method Detail

get

public GetResponse get(ObjectTypePlural objectType,
                       String objectId)

get

public GetResponse get(GetDbsqlPermissionRequest request)

Gets a JSON representation of the access control list (ACL) for a specified object.

**Warning**: This API is deprecated. Please use :method:workspace/getpermissions instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

set

public SetResponse set(SetRequest request)

Sets the access control list (ACL) for a specified object. This operation will complete rewrite the ACL.

**Warning**: This API is deprecated. Please use :method:workspace/setpermissions instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

transferOwnership

public Success transferOwnership(TransferOwnershipRequest request)

Transfers ownership of a dashboard, query, or alert to an active user. Requires an admin API key.

**Warning**: This API is deprecated. For queries and alerts, please use :method:queries/update and :method:alerts/update respectively instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

impl

public DbsqlPermissionsService impl()