com.databricks.sdk.service.catalog

Interface GrantsService

@Generated
public interface GrantsService

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.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
GetPermissionsResponse	get(GetGrantRequest getGrantRequest) Gets the permissions for a securable.
EffectivePermissionsList	getEffective(GetEffectiveRequest getEffectiveRequest) Gets the effective permissions for a securable.
UpdatePermissionsResponse	update(UpdatePermissions updatePermissions) Updates the permissions for a securable.

Method Detail

get

GetPermissionsResponse get(GetGrantRequest getGrantRequest)

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

EffectivePermissionsList getEffective(GetEffectiveRequest getEffectiveRequest)

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

UpdatePermissionsResponse update(UpdatePermissions updatePermissions)

Updates the permissions for a securable.