com.databricks.sdk.service.sharing

Class RecipientActivationAPI

java.lang.Object

com.databricks.sdk.service.sharing.RecipientActivationAPI

@Generated
public class RecipientActivationAPI
extends Object

The Recipient Activation API is only applicable in the open sharing model where the recipient object has the authentication type of `TOKEN`. The data recipient follows the activation link shared by the data provider to download the credential file that includes the access token. The recipient will then use the credential file to establish a secure connection with the provider to receive the shared data.

Note that you can download the credential file only once. Recipients should treat the downloaded credential as a secret and must not share it outside of their organization.

Constructor Summary

Constructors

Constructor and Description
RecipientActivationAPI(ApiClient apiClient) Regular-use constructor
RecipientActivationAPI(RecipientActivationService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	getActivationUrlInfo(GetActivationUrlInfoRequest request) Get a share activation URL.
void	getActivationUrlInfo(String activationUrl)
RecipientActivationService	impl()
RetrieveTokenResponse	retrieveToken(RetrieveTokenRequest request) Get an access token.
RetrieveTokenResponse	retrieveToken(String activationUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipientActivationAPI

public RecipientActivationAPI(ApiClient apiClient)

Regular-use constructor

RecipientActivationAPI

public RecipientActivationAPI(RecipientActivationService mock)

Constructor for mocks

Method Detail

getActivationUrlInfo

public void getActivationUrlInfo(String activationUrl)

getActivationUrlInfo

public void getActivationUrlInfo(GetActivationUrlInfoRequest request)

Get a share activation URL.

Gets an activation URL for a share.

retrieveToken

public RetrieveTokenResponse retrieveToken(String activationUrl)

retrieveToken

public RetrieveTokenResponse retrieveToken(RetrieveTokenRequest request)

Get an access token.

Retrieve access token with an activation url. This is a public API without any authentication.

impl

public RecipientActivationService impl()