com.databricks.sdk.service.catalog

Class PoliciesAPI

java.lang.Object

com.databricks.sdk.service.catalog.PoliciesAPI

@Generated
public class PoliciesAPI
extends Object

Attribute-Based Access Control (ABAC) provides high leverage governance for enforcing compliance policies in Unity Catalog. With ABAC policies, access is controlled in a hierarchical and scalable manner, based on data attributes rather than specific resources, enabling more flexible and comprehensive access control. ABAC policies in Unity Catalog support conditions on securable properties, governance tags, and environment contexts. Callers must have the `MANAGE` privilege on a securable to view, create, update, or delete ABAC policies.

Constructor Summary

Constructors

Constructor and Description
PoliciesAPI(ApiClient apiClient) Regular-use constructor
PoliciesAPI(PoliciesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
PolicyInfo	createPolicy(CreatePolicyRequest request) Creates a new policy on a securable.
DeletePolicyResponse	deletePolicy(DeletePolicyRequest request) Delete an ABAC policy defined on a securable.
DeletePolicyResponse	deletePolicy(String onSecurableType, String onSecurableFullname, String name)
PolicyInfo	getPolicy(GetPolicyRequest request) Get the policy definition on a securable
PolicyInfo	getPolicy(String onSecurableType, String onSecurableFullname, String name)
PoliciesService	impl()
Iterable<PolicyInfo>	listPolicies(ListPoliciesRequest request) List all policies defined on a securable.
Iterable<PolicyInfo>	listPolicies(String onSecurableType, String onSecurableFullname)
PolicyInfo	updatePolicy(UpdatePolicyRequest request) Update an ABAC policy on a securable.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoliciesAPI

public PoliciesAPI(ApiClient apiClient)

Regular-use constructor

PoliciesAPI

public PoliciesAPI(PoliciesService mock)

Constructor for mocks

Method Detail

createPolicy

public PolicyInfo createPolicy(CreatePolicyRequest request)

Creates a new policy on a securable. The new policy applies to the securable and all its descendants.

deletePolicy

public DeletePolicyResponse deletePolicy(String onSecurableType,
                                         String onSecurableFullname,
                                         String name)

deletePolicy

public DeletePolicyResponse deletePolicy(DeletePolicyRequest request)

Delete an ABAC policy defined on a securable.

getPolicy

public PolicyInfo getPolicy(String onSecurableType,
                            String onSecurableFullname,
                            String name)

getPolicy

public PolicyInfo getPolicy(GetPolicyRequest request)

Get the policy definition on a securable

listPolicies

public Iterable<PolicyInfo> listPolicies(String onSecurableType,
                                         String onSecurableFullname)

listPolicies

public Iterable<PolicyInfo> listPolicies(ListPoliciesRequest request)

List all policies defined on a securable. Optionally, the list can include inherited policies defined on the securable's parent schema or catalog.

PAGINATION BEHAVIOR: The API is by default paginated, 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.

updatePolicy

public PolicyInfo updatePolicy(UpdatePolicyRequest request)

Update an ABAC policy on a securable.

impl

public PoliciesService impl()