Skip to content

Recipient

laktory.models.resources.databricks.Recipient ¤

Bases: RecipientBase

Databricks Recipient for Delta Sharing

A recipient is an entity that can receive shared data from a Databricks workspace. Recipients can be configured with authentication details to enable Delta Sharing.

Examples:

import io

from laktory import models

recipient_yaml = '''
name: partner-org
authentication_type: TOKEN
comment: External partner for data sharing
'''
recipient = models.resources.databricks.Recipient.model_validate_yaml(
    io.StringIO(recipient_yaml)
)
References
BASE DESCRIPTION
authentication_type

The delta sharing authentication type. Valid values are TOKEN and DATABRICKS

TYPE: str | VariableType

comment

Description about the recipient

TYPE: str | None | VariableType DEFAULT: None

data_recipient_global_metastore_id

Required when authentication_type is DATABRICKS

TYPE: str | None | VariableType DEFAULT: None

expiration_time

Expiration timestamp of the token in epoch milliseconds

TYPE: int | None | VariableType DEFAULT: None

ip_access_list

Recipient IP access list

TYPE: RecipientIpAccessList | None | VariableType DEFAULT: None

name

Name of recipient. Change forces creation of a new resource

TYPE: str | VariableType

owner

Username/groupname/sp application_id of the recipient owner

TYPE: str | None | VariableType DEFAULT: None

properties_kvpairs

Recipient properties - object consisting of following fields: * properties (Required) a map of string key-value pairs with recipient's properties. Properties with name starting with databricks. are reserved

TYPE: RecipientPropertiesKvpairs | None | VariableType DEFAULT: None

sharing_code

The one-time sharing code provided by the data recipient

TYPE: str | None | VariableType DEFAULT: None

tokens

List of Recipient Tokens. This field is only present when the authentication_type is TOKEN. Each list element is an object with following attributes:

TYPE: list[RecipientTokens] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.recipient.RecipientIpAccessList ¤

Bases: BaseModel

PARAMETER DESCRIPTION
allowed_ip_addresses

Allowed IP Addresses in CIDR notation. Limit of 100

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.recipient.RecipientPropertiesKvpairs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
properties

TYPE: dict[str, str] | VariableType


laktory.models.resources.databricks.recipient.RecipientTokens ¤

Bases: BaseModel