com.databricks.sdk.service.catalog

Class RfaAPI

java.lang.Object

com.databricks.sdk.service.catalog.RfaAPI

@Generated
public class RfaAPI
extends Object

Request for Access enables users to request access for Unity Catalog securables.

These APIs provide a standardized way for securable owners (or users with MANAGE privileges) to manage access request destinations.

Constructor Summary

Constructors

Constructor and Description
RfaAPI(ApiClient apiClient) Regular-use constructor
RfaAPI(RfaService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
BatchCreateAccessRequestsResponse	batchCreateAccessRequests(BatchCreateAccessRequestsRequest request) Creates access requests for Unity Catalog permissions for a specified principal on a securable object.
AccessRequestDestinations	getAccessRequestDestinations(GetAccessRequestDestinationsRequest request) Gets an array of access request destinations for the specified securable.
AccessRequestDestinations	getAccessRequestDestinations(String securableType, String fullName)
RfaService	impl()
AccessRequestDestinations	updateAccessRequestDestinations(UpdateAccessRequestDestinationsRequest request) Updates the access request destinations for the given securable.

Methods inherited from class java.lang.Object

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

Constructor Detail

RfaAPI

public RfaAPI(ApiClient apiClient)

Regular-use constructor

RfaAPI

public RfaAPI(RfaService mock)

Constructor for mocks

Method Detail

batchCreateAccessRequests

public BatchCreateAccessRequestsResponse batchCreateAccessRequests(BatchCreateAccessRequestsRequest request)

Creates access requests for Unity Catalog permissions for a specified principal on a securable object. This Batch API can take in multiple principals, securable objects, and permissions as the input and returns the access request destinations for each. Principals must be unique across the API call.

The supported securable types are: "metastore", "catalog", "schema", "table", "external_location", "connection", "credential", "function", "registered_model", and "volume".

getAccessRequestDestinations

public AccessRequestDestinations getAccessRequestDestinations(String securableType,
                                                              String fullName)

getAccessRequestDestinations

public AccessRequestDestinations getAccessRequestDestinations(GetAccessRequestDestinationsRequest request)

Gets an array of access request destinations for the specified securable. Any caller can see URL destinations or the destinations on the metastore. Otherwise, only those with **BROWSE** permissions on the securable can see destinations.

The supported securable types are: "metastore", "catalog", "schema", "table", "external_location", "connection", "credential", "function", "registered_model", and "volume".

updateAccessRequestDestinations

public AccessRequestDestinations updateAccessRequestDestinations(UpdateAccessRequestDestinationsRequest request)

Updates the access request destinations for the given securable. The caller must be a metastore admin, the owner of the securable, or a user that has the **MANAGE** privilege on the securable in order to assign destinations. Destinations cannot be updated for securables underneath schemas (tables, volumes, functions, and models). For these securable types, destinations are inherited from the parent securable. A maximum of 5 emails and 5 external notification destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be assigned to a securable. If a URL destination is assigned, no other destinations can be set.

The supported securable types are: "metastore", "catalog", "schema", "table", "external_location", "connection", "credential", "function", "registered_model", and "volume".

impl

public RfaService impl()