Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateRecipientRequest

    interface UpdateRecipientRequest {
        activated?: boolean;
        activationUrl?: string;
        authenticationType?: DeltaSharingAuthenticationType;
        cloud?: string;
        comment?: string;
        createdAt?: bigint;
        createdBy?: string;
        dataRecipientGlobalMetastoreId?: string;
        expirationTime?: bigint;
        id?: string;
        ipAccessList?: IpAccessList;
        metastoreId?: string;
        name?: string;
        nameArg?: string;
        newName?: string;
        owner?: string;
        propertiesKvpairs?: PropertiesKvPairs;
        region?: string;
        sharingCode?: string;
        tokens?: RecipientTokenInfo[];
        updatedAt?: bigint;
        updatedBy?: string;
    }
    Index

    Properties

    activated? activationUrl? authenticationType? cloud? comment? createdAt? createdBy? dataRecipientGlobalMetastoreId? expirationTime? id? ipAccessList? metastoreId? name? nameArg? newName? owner? propertiesKvpairs? region? sharingCode? tokens? updatedAt? updatedBy?

    Properties

    activated?: boolean

    A boolean status field showing whether the Recipient's activation URL has been exercised or not.

    activationUrl?: string

    Full activation url to retrieve the access token. It will be empty if the token is already retrieved.

    authenticationType?: DeltaSharingAuthenticationType
    cloud?: string

    Cloud vendor of the recipient's Unity Catalog Metastore. This field is only present when the authentication_type is DATABRICKS.

    comment?: string

    Description about the recipient.

    createdAt?: bigint

    Time at which this recipient was created, in epoch milliseconds.

    createdBy?: string

    Username of recipient creator.

    dataRecipientGlobalMetastoreId?: string

    The global Unity Catalog metastore id provided by the data recipient. This field is only present when the authentication_type is DATABRICKS. The identifier is of format cloud:region:metastore-uuid.

    expirationTime?: bigint

    Expiration timestamp of the token, in epoch milliseconds.

    id?: string

    [Create,Update:IGN] common - id of the recipient

    ipAccessList?: IpAccessList

    IP Access List

    metastoreId?: string

    Unique identifier of recipient's Unity Catalog Metastore. This field is only present when the authentication_type is DATABRICKS.

    name?: string

    Name of Recipient.

    nameArg?: string

    Name of the recipient.

    newName?: string

    New name for the recipient. .

    owner?: string

    Username of the recipient owner.

    propertiesKvpairs?: PropertiesKvPairs

    Recipient properties as map of string key-value pairs. When provided in update request, the specified properties will override the existing properties. To add and remove properties, one would need to perform a read-modify-write.

    region?: string

    Cloud region of the recipient's Unity Catalog Metastore. This field is only present when the authentication_type is DATABRICKS.

    sharingCode?: string

    The one-time sharing code provided by the data recipient. This field is only present when the authentication_type is DATABRICKS.

    tokens?: RecipientTokenInfo[]

    This field is only present when the authentication_type is TOKEN.

    updatedAt?: bigint

    Time at which the recipient was updated, in epoch milliseconds.

    updatedBy?: string

    Username of recipient updater.

    Settings

    Member Visibility

    On This Page

    Properties