com.databricks.sdk.service.sharing

Interface RecipientsService

@Generated
public interface RecipientsService

A recipient is an object you create using :method:recipients/create to represent an organization which you want to allow access shares. The way how sharing works differs depending on whether or not your recipient has access to a Databricks workspace that is enabled for Unity Catalog:

- For recipients with access to a Databricks workspace that is enabled for Unity Catalog, you can create a recipient object along with a unique sharing identifier you get from the recipient. The sharing identifier is the key identifier that enables the secure connection. This sharing mode is called **Databricks-to-Databricks sharing**.

- For recipients without access to a Databricks workspace that is enabled for Unity Catalog, when you create a recipient object, Databricks generates an activation link you can send to the recipient. The recipient follows the activation link to download the credential file, and then uses the credential file to establish a secure connection to receive the shared data. This sharing mode is called **open sharing**.

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
RecipientInfo	create(CreateRecipient createRecipient) Create a share recipient.
void	delete(DeleteRecipientRequest deleteRecipientRequest) Delete a share recipient.
RecipientInfo	get(GetRecipientRequest getRecipientRequest) Get a share recipient.
ListRecipientsResponse	list(ListRecipientsRequest listRecipientsRequest) List share recipients.
RecipientInfo	rotateToken(RotateRecipientToken rotateRecipientToken) Rotate a token.
GetRecipientSharePermissionsResponse	sharePermissions(SharePermissionsRequest sharePermissionsRequest) Get recipient share permissions.
void	update(UpdateRecipient updateRecipient) Update a share recipient.

Method Detail

create

RecipientInfo create(CreateRecipient createRecipient)

Create a share recipient.

Creates a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or has the **CREATE_RECIPIENT** privilege on the metastore.

delete

void delete(DeleteRecipientRequest deleteRecipientRequest)

Delete a share recipient.

Deletes the specified recipient from the metastore. The caller must be the owner of the recipient.

get

RecipientInfo get(GetRecipientRequest getRecipientRequest)

Get a share recipient.

Gets a share recipient from the metastore if:

* the caller is the owner of the share recipient, or: * is a metastore admin

list

ListRecipientsResponse list(ListRecipientsRequest listRecipientsRequest)

List share recipients.

Gets an array of all share recipients within the current metastore where:

* the caller is a metastore admin, or * the caller is the owner. There is no guarantee of a specific ordering of the elements in the array.

rotateToken

RecipientInfo rotateToken(RotateRecipientToken rotateRecipientToken)

Rotate a token.

Refreshes the specified recipient's delta sharing authentication token with the provided token info. The caller must be the owner of the recipient.

sharePermissions

GetRecipientSharePermissionsResponse sharePermissions(SharePermissionsRequest sharePermissionsRequest)

Get recipient share permissions.

Gets the share permissions for the specified Recipient. The caller must be a metastore admin or the owner of the Recipient.

update

void update(UpdateRecipient updateRecipient)

Update a share recipient.

Updates an existing recipient in the metastore. The caller must be a metastore admin or the owner of the recipient. If the recipient name will be updated, the user must be both a metastore admin and the owner of the recipient.