com.databricks.sdk.service.catalog

Class GrantsAPI

java.lang.Object

com.databricks.sdk.service.catalog.GrantsAPI

@Generated
public class GrantsAPI
extends Object

In Unity Catalog, data is secure by default. Initially, users have no access to data in a metastore. Access can be granted by either a metastore admin, the owner of an object, or the owner of the catalog or schema that contains the object. Securable objects in Unity Catalog are hierarchical and privileges are inherited downward.

Securable objects in Unity Catalog are hierarchical and privileges are inherited downward. This means that granting a privilege on the catalog automatically grants the privilege to all current and future objects within the catalog. Similarly, privileges granted on a schema are inherited by all current and future objects within that schema.

Constructor Summary

Constructors

Constructor and Description
GrantsAPI(ApiClient apiClient) Regular-use constructor
GrantsAPI(GrantsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
GetPermissionsResponse	get(GetGrantRequest request) Gets the permissions for a securable.
GetPermissionsResponse	get(String securableType, String fullName)
EffectivePermissionsList	getEffective(GetEffectiveRequest request) Gets the effective permissions for a securable.
EffectivePermissionsList	getEffective(String securableType, String fullName)
GrantsService	impl()
UpdatePermissionsResponse	update(UpdatePermissions request) Updates the permissions for a securable.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrantsAPI

public GrantsAPI(ApiClient apiClient)

Regular-use constructor

GrantsAPI

public GrantsAPI(GrantsService mock)

Constructor for mocks

Method Detail

get

public GetPermissionsResponse get(String securableType,
                                  String fullName)

get

public GetPermissionsResponse get(GetGrantRequest request)

Gets the permissions for a securable. Does not include inherited permissions.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

getEffective

public EffectivePermissionsList getEffective(String securableType,
                                             String fullName)

getEffective

public EffectivePermissionsList getEffective(GetEffectiveRequest request)

Gets the effective permissions for a securable. Includes inherited permissions from any parent securables.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

update

public UpdatePermissionsResponse update(UpdatePermissions request)

Updates the permissions for a securable.

impl

public GrantsService impl()