Delta Sharing

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.sharing module.

class databricks.sdk.service.sharing.AuthenticationType

The delta sharing authentication type.

DATABRICKS = "DATABRICKS"

OAUTH_CLIENT_CREDENTIALS = "OAUTH_CLIENT_CREDENTIALS"

OIDC_FEDERATION = "OIDC_FEDERATION"

TOKEN = "TOKEN"

class databricks.sdk.service.sharing.ColumnTypeName

UC supported column types Copied from https://src.dev.databricks.com/databricks/universe@23a85902bb58695ab9293adc9f327b0714b55e72/-/blob/managed-catalog/api/messages/table.proto?L68

ARRAY = "ARRAY"

BINARY = "BINARY"

BOOLEAN = "BOOLEAN"

BYTE = "BYTE"

CHAR = "CHAR"

DATE = "DATE"

DECIMAL = "DECIMAL"

DOUBLE = "DOUBLE"

FLOAT = "FLOAT"

INT = "INT"

INTERVAL = "INTERVAL"

LONG = "LONG"

MAP = "MAP"

NULL = "NULL"

SHORT = "SHORT"

STRING = "STRING"

STRUCT = "STRUCT"

TABLE_TYPE = "TABLE_TYPE"

TIMESTAMP = "TIMESTAMP"

TIMESTAMP_NTZ = "TIMESTAMP_NTZ"

USER_DEFINED_TYPE = "USER_DEFINED_TYPE"

VARIANT = "VARIANT"

class databricks.sdk.service.sharing.DeltaSharingDependency(function: DeltaSharingFunctionDependency | None = None, table: DeltaSharingTableDependency | None = None)

Represents a UC dependency.

function: DeltaSharingFunctionDependency | None = None

table: DeltaSharingTableDependency | None = None

as_dict() → dict

Serializes the DeltaSharingDependency into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeltaSharingDependency into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeltaSharingDependency

Deserializes the DeltaSharingDependency from a dictionary.

class databricks.sdk.service.sharing.DeltaSharingDependencyList(dependencies: List[DeltaSharingDependency] | None = None)

Represents a list of dependencies.

dependencies: List[DeltaSharingDependency] | None = None

An array of Dependency.

as_dict() → dict

Serializes the DeltaSharingDependencyList into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeltaSharingDependencyList into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeltaSharingDependencyList

Deserializes the DeltaSharingDependencyList from a dictionary.

class databricks.sdk.service.sharing.DeltaSharingFunction(aliases: 'Optional[List[RegisteredModelAlias]]' = None, comment: 'Optional[str]' = None, data_type: 'Optional[ColumnTypeName]' = None, dependency_list: 'Optional[DeltaSharingDependencyList]' = None, full_data_type: 'Optional[str]' = None, id: 'Optional[str]' = None, input_params: 'Optional[FunctionParameterInfos]' = None, name: 'Optional[str]' = None, properties: 'Optional[str]' = None, routine_definition: 'Optional[str]' = None, schema: 'Optional[str]' = None, securable_kind: 'Optional[SharedSecurableKind]' = None, share: 'Optional[str]' = None, share_id: 'Optional[str]' = None, storage_location: 'Optional[str]' = None, tags: 'Optional[List[catalog.TagKeyValue]]' = None)

aliases: List[RegisteredModelAlias] | None = None

The aliass of registered model.

comment: str | None = None

The comment of the function.

data_type: ColumnTypeName | None = None

The data type of the function.

dependency_list: DeltaSharingDependencyList | None = None

The dependency list of the function.

full_data_type: str | None = None

The full data type of the function.

id: str | None = None

The id of the function.

input_params: FunctionParameterInfos | None = None

The function parameter information.

name: str | None = None

The name of the function.

properties: str | None = None

The properties of the function.

routine_definition: str | None = None

The routine definition of the function.

schema: str | None = None

The name of the schema that the function belongs to.

securable_kind: SharedSecurableKind | None = None

The securable kind of the function.

share: str | None = None

The name of the share that the function belongs to.

share_id: str | None = None

The id of the share that the function belongs to.

storage_location: str | None = None

The storage location of the function.

tags: List[TagKeyValue] | None = None

The tags of the function.

as_dict() → dict

Serializes the DeltaSharingFunction into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeltaSharingFunction into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeltaSharingFunction

Deserializes the DeltaSharingFunction from a dictionary.

class databricks.sdk.service.sharing.DeltaSharingFunctionDependency(function_name: str | None = None, schema_name: str | None = None)

A Function in UC as a dependency.

function_name: str | None = None

schema_name: str | None = None

as_dict() → dict

Serializes the DeltaSharingFunctionDependency into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeltaSharingFunctionDependency into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeltaSharingFunctionDependency

Deserializes the DeltaSharingFunctionDependency from a dictionary.

class databricks.sdk.service.sharing.DeltaSharingTableDependency(schema_name: str | None = None, table_name: str | None = None)

A Table in UC as a dependency.

schema_name: str | None = None

table_name: str | None = None

as_dict() → dict

Serializes the DeltaSharingTableDependency into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeltaSharingTableDependency into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeltaSharingTableDependency

Deserializes the DeltaSharingTableDependency from a dictionary.

class databricks.sdk.service.sharing.FederationPolicy(comment: 'Optional[str]' = None, create_time: 'Optional[str]' = None, id: 'Optional[str]' = None, name: 'Optional[str]' = None, oidc_policy: 'Optional[OidcFederationPolicy]' = None, update_time: 'Optional[str]' = None)

comment: str | None = None

Description of the policy. This is a user-provided description.

create_time: str | None = None

System-generated timestamp indicating when the policy was created.

id: str | None = None

Unique, immutable system-generated identifier for the federation policy.

name: str | None = None

Name of the federation policy. A recipient can have multiple policies with different names. The name must contain only lowercase alphanumeric characters, numbers, and hyphens.

oidc_policy: OidcFederationPolicy | None = None

Specifies the policy to use for validating OIDC claims in the federated tokens.

update_time: str | None = None

System-generated timestamp indicating when the policy was last updated.

as_dict() → dict

Serializes the FederationPolicy into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the FederationPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → FederationPolicy

Deserializes the FederationPolicy from a dictionary.

class databricks.sdk.service.sharing.FunctionParameterInfo(comment: str | None = None, name: str | None = None, parameter_default: str | None = None, parameter_mode: FunctionParameterMode | None = None, parameter_type: FunctionParameterType | None = None, position: int | None = None, type_interval_type: str | None = None, type_json: str | None = None, type_name: ColumnTypeName | None = None, type_precision: int | None = None, type_scale: int | None = None, type_text: str | None = None)

Represents a parameter of a function. The same message is used for both input and output columns.

comment: str | None = None

The comment of the parameter.

name: str | None = None

The name of the parameter.

parameter_default: str | None = None

The default value of the parameter.

parameter_mode: FunctionParameterMode | None = None

The mode of the function parameter.

parameter_type: FunctionParameterType | None = None

The type of the function parameter.

position: int | None = None

The position of the parameter.

type_interval_type: str | None = None

The interval type of the parameter type.

type_json: str | None = None

The type of the parameter in JSON format.

type_name: ColumnTypeName | None = None

The type of the parameter in Enum format.

type_precision: int | None = None

The precision of the parameter type.

type_scale: int | None = None

The scale of the parameter type.

type_text: str | None = None

The type of the parameter in text format.

as_dict() → dict

Serializes the FunctionParameterInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the FunctionParameterInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → FunctionParameterInfo

Deserializes the FunctionParameterInfo from a dictionary.

class databricks.sdk.service.sharing.FunctionParameterInfos(parameters: 'Optional[List[FunctionParameterInfo]]' = None)

parameters: List[FunctionParameterInfo] | None = None

The list of parameters of the function.

as_dict() → dict

Serializes the FunctionParameterInfos into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the FunctionParameterInfos into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → FunctionParameterInfos

Deserializes the FunctionParameterInfos from a dictionary.

class databricks.sdk.service.sharing.FunctionParameterMode

IN = "IN"

INOUT = "INOUT"

OUT = "OUT"

class databricks.sdk.service.sharing.FunctionParameterType

COLUMN = "COLUMN"

PARAM = "PARAM"

class databricks.sdk.service.sharing.GetActivationUrlInfoResponse

as_dict() → dict

Serializes the GetActivationUrlInfoResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GetActivationUrlInfoResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GetActivationUrlInfoResponse

Deserializes the GetActivationUrlInfoResponse from a dictionary.

class databricks.sdk.service.sharing.GetRecipientSharePermissionsResponse(next_page_token: 'Optional[str]' = None, permissions_out: 'Optional[List[ShareToPrivilegeAssignment]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

permissions_out: List[ShareToPrivilegeAssignment] | None = None

An array of data share permissions for a recipient.

as_dict() → dict

Serializes the GetRecipientSharePermissionsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GetRecipientSharePermissionsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GetRecipientSharePermissionsResponse

Deserializes the GetRecipientSharePermissionsResponse from a dictionary.

class databricks.sdk.service.sharing.GetSharePermissionsResponse(next_page_token: 'Optional[str]' = None, privilege_assignments: 'Optional[List[PrivilegeAssignment]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

privilege_assignments: List[PrivilegeAssignment] | None = None

The privileges assigned to each principal

as_dict() → dict

Serializes the GetSharePermissionsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GetSharePermissionsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GetSharePermissionsResponse

Deserializes the GetSharePermissionsResponse from a dictionary.

class databricks.sdk.service.sharing.IpAccessList(allowed_ip_addresses: 'Optional[List[str]]' = None)

allowed_ip_addresses: List[str] | None = None

Allowed IP Addresses in CIDR notation. Limit of 100.

as_dict() → dict

Serializes the IpAccessList into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the IpAccessList into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → IpAccessList

Deserializes the IpAccessList from a dictionary.

class databricks.sdk.service.sharing.ListFederationPoliciesResponse(next_page_token: 'Optional[str]' = None, policies: 'Optional[List[FederationPolicy]]' = None)

next_page_token: str | None = None

policies: List[FederationPolicy] | None = None

as_dict() → dict

Serializes the ListFederationPoliciesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListFederationPoliciesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListFederationPoliciesResponse

Deserializes the ListFederationPoliciesResponse from a dictionary.

class databricks.sdk.service.sharing.ListProviderShareAssetsResponse(functions: List[DeltaSharingFunction] | None = None, notebooks: List[NotebookFile] | None = None, share: Share | None = None, tables: List[Table] | None = None, volumes: List[Volume] | None = None)

Response to ListProviderShareAssets, which contains the list of assets of a share.

functions: List[DeltaSharingFunction] | None = None

The list of functions in the share.

notebooks: List[NotebookFile] | None = None

The list of notebooks in the share.

share: Share | None = None

The metadata of the share.

tables: List[Table] | None = None

The list of tables in the share.

volumes: List[Volume] | None = None

The list of volumes in the share.

as_dict() → dict

Serializes the ListProviderShareAssetsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListProviderShareAssetsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListProviderShareAssetsResponse

Deserializes the ListProviderShareAssetsResponse from a dictionary.

class databricks.sdk.service.sharing.ListProviderSharesResponse(next_page_token: 'Optional[str]' = None, shares: 'Optional[List[ProviderShare]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

shares: List[ProviderShare] | None = None

An array of provider shares.

as_dict() → dict

Serializes the ListProviderSharesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListProviderSharesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListProviderSharesResponse

Deserializes the ListProviderSharesResponse from a dictionary.

class databricks.sdk.service.sharing.ListProvidersResponse(next_page_token: 'Optional[str]' = None, providers: 'Optional[List[ProviderInfo]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

providers: List[ProviderInfo] | None = None

An array of provider information objects.

as_dict() → dict

Serializes the ListProvidersResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListProvidersResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListProvidersResponse

Deserializes the ListProvidersResponse from a dictionary.

class databricks.sdk.service.sharing.ListRecipientsResponse(next_page_token: 'Optional[str]' = None, recipients: 'Optional[List[RecipientInfo]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

recipients: List[RecipientInfo] | None = None

An array of recipient information objects.

as_dict() → dict

Serializes the ListRecipientsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListRecipientsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListRecipientsResponse

Deserializes the ListRecipientsResponse from a dictionary.

class databricks.sdk.service.sharing.ListSharesResponse(next_page_token: 'Optional[str]' = None, shares: 'Optional[List[ShareInfo]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

shares: List[ShareInfo] | None = None

An array of data share information objects.

as_dict() → dict

Serializes the ListSharesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListSharesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListSharesResponse

Deserializes the ListSharesResponse from a dictionary.

class databricks.sdk.service.sharing.NotebookFile(comment: 'Optional[str]' = None, id: 'Optional[str]' = None, name: 'Optional[str]' = None, share: 'Optional[str]' = None, share_id: 'Optional[str]' = None, tags: 'Optional[List[catalog.TagKeyValue]]' = None)

comment: str | None = None

The comment of the notebook file.

id: str | None = None

The id of the notebook file.

name: str | None = None

Name of the notebook file.

share: str | None = None

The name of the share that the notebook file belongs to.

share_id: str | None = None

The id of the share that the notebook file belongs to.

tags: List[TagKeyValue] | None = None

The tags of the notebook file.

as_dict() → dict

Serializes the NotebookFile into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the NotebookFile into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → NotebookFile

Deserializes the NotebookFile from a dictionary.

class databricks.sdk.service.sharing.OidcFederationPolicy(issuer: str, subject_claim: str, subject: str, audiences: List[str] | None = None)

Specifies the policy to use for validating OIDC claims in your federated tokens from Delta Sharing Clients. Refer to https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed for more details.

issuer: str

The required token issuer, as specified in the ‘iss’ claim of federated tokens.

subject_claim: str

The claim that contains the subject of the token. Depending on the identity provider and the use case (U2M or M2M), this can vary: - For Entra ID (AAD): * U2M flow (group access): Use groups. * U2M flow (user access): Use oid. * M2M flow (OAuth App access): Use azp. - For other IdPs, refer to the specific IdP documentation.

Supported subject_claim values are: - oid: Object ID of the user. - azp: Client ID of the OAuth app. - groups: Object ID of the group. - sub: Subject identifier for other use cases.

subject: str

The required token subject, as specified in the subject claim of federated tokens. The subject claim identifies the identity of the user or machine accessing the resource. Examples for Entra ID (AAD): - U2M flow (group access): If the subject claim is groups, this must be the Object ID of the group in Entra ID. - U2M flow (user access): If the subject claim is oid, this must be the Object ID of the user in Entra ID. - M2M flow (OAuth App access): If the subject claim is azp, this must be the client ID of the OAuth app registered in Entra ID.

audiences: List[str] | None = None

The allowed token audiences, as specified in the ‘aud’ claim of federated tokens. The audience identifier is intended to represent the recipient of the token. Can be any non-empty string value. As long as the audience in the token matches at least one audience in the policy,

as_dict() → dict

Serializes the OidcFederationPolicy into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the OidcFederationPolicy into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → OidcFederationPolicy

Deserializes the OidcFederationPolicy from a dictionary.

class databricks.sdk.service.sharing.Partition(values: 'Optional[List[PartitionValue]]' = None)

values: List[PartitionValue] | None = None

An array of partition values.

as_dict() → dict

Serializes the Partition into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Partition into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Partition

Deserializes the Partition from a dictionary.

class databricks.sdk.service.sharing.PartitionValue(name: 'Optional[str]' = None, op: 'Optional[PartitionValueOp]' = None, recipient_property_key: 'Optional[str]' = None, value: 'Optional[str]' = None)

name: str | None = None

The name of the partition column.

op: PartitionValueOp | None = None

The operator to apply for the value.

recipient_property_key: str | None = None

The key of a Delta Sharing recipient’s property. For example “databricks-account-id”. When this field is set, field value can not be set.

value: str | None = None

The value of the partition column. When this value is not set, it means null value. When this field is set, field recipient_property_key can not be set.

as_dict() → dict

Serializes the PartitionValue into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the PartitionValue into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → PartitionValue

Deserializes the PartitionValue from a dictionary.

class databricks.sdk.service.sharing.PartitionValueOp

EQUAL = "EQUAL"

LIKE = "LIKE"

class databricks.sdk.service.sharing.PermissionsChange(add: 'Optional[List[str]]' = None, principal: 'Optional[str]' = None, remove: 'Optional[List[str]]' = None)

add: List[str] | None = None

The set of privileges to add.

principal: str | None = None

The principal whose privileges we are changing. Only one of principal or principal_id should be specified, never both at the same time.

remove: List[str] | None = None

The set of privileges to remove.

as_dict() → dict

Serializes the PermissionsChange into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the PermissionsChange into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → PermissionsChange

Deserializes the PermissionsChange from a dictionary.

class databricks.sdk.service.sharing.Privilege

ACCESS = "ACCESS"

ALL_PRIVILEGES = "ALL_PRIVILEGES"

APPLY_TAG = "APPLY_TAG"

CREATE = "CREATE"

CREATE_CATALOG = "CREATE_CATALOG"

CREATE_CONNECTION = "CREATE_CONNECTION"

CREATE_EXTERNAL_LOCATION = "CREATE_EXTERNAL_LOCATION"

CREATE_EXTERNAL_TABLE = "CREATE_EXTERNAL_TABLE"

CREATE_EXTERNAL_VOLUME = "CREATE_EXTERNAL_VOLUME"

CREATE_FOREIGN_CATALOG = "CREATE_FOREIGN_CATALOG"

CREATE_FOREIGN_SECURABLE = "CREATE_FOREIGN_SECURABLE"

CREATE_FUNCTION = "CREATE_FUNCTION"

CREATE_MANAGED_STORAGE = "CREATE_MANAGED_STORAGE"

CREATE_MATERIALIZED_VIEW = "CREATE_MATERIALIZED_VIEW"

CREATE_MODEL = "CREATE_MODEL"

CREATE_PROVIDER = "CREATE_PROVIDER"

CREATE_RECIPIENT = "CREATE_RECIPIENT"

CREATE_SCHEMA = "CREATE_SCHEMA"

CREATE_SERVICE_CREDENTIAL = "CREATE_SERVICE_CREDENTIAL"

CREATE_SHARE = "CREATE_SHARE"

CREATE_STORAGE_CREDENTIAL = "CREATE_STORAGE_CREDENTIAL"

CREATE_TABLE = "CREATE_TABLE"

CREATE_VIEW = "CREATE_VIEW"

CREATE_VOLUME = "CREATE_VOLUME"

EXECUTE = "EXECUTE"

MANAGE = "MANAGE"

MANAGE_ALLOWLIST = "MANAGE_ALLOWLIST"

MODIFY = "MODIFY"

READ_FILES = "READ_FILES"

READ_PRIVATE_FILES = "READ_PRIVATE_FILES"

READ_VOLUME = "READ_VOLUME"

REFRESH = "REFRESH"

SELECT = "SELECT"

SET_SHARE_PERMISSION = "SET_SHARE_PERMISSION"

USAGE = "USAGE"

USE_CATALOG = "USE_CATALOG"

USE_CONNECTION = "USE_CONNECTION"

USE_MARKETPLACE_ASSETS = "USE_MARKETPLACE_ASSETS"

USE_PROVIDER = "USE_PROVIDER"

USE_RECIPIENT = "USE_RECIPIENT"

USE_SCHEMA = "USE_SCHEMA"

USE_SHARE = "USE_SHARE"

WRITE_FILES = "WRITE_FILES"

WRITE_PRIVATE_FILES = "WRITE_PRIVATE_FILES"

WRITE_VOLUME = "WRITE_VOLUME"

class databricks.sdk.service.sharing.PrivilegeAssignment(principal: 'Optional[str]' = None, privileges: 'Optional[List[Privilege]]' = None)

principal: str | None = None

The principal (user email address or group name). For deleted principals, principal is empty while principal_id is populated.

privileges: List[Privilege] | None = None

The privileges assigned to the principal.

as_dict() → dict

Serializes the PrivilegeAssignment into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the PrivilegeAssignment into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → PrivilegeAssignment

Deserializes the PrivilegeAssignment from a dictionary.

class databricks.sdk.service.sharing.ProviderInfo(authentication_type: 'Optional[AuthenticationType]' = None, cloud: 'Optional[str]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, data_provider_global_metastore_id: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, recipient_profile: 'Optional[RecipientProfile]' = None, recipient_profile_str: 'Optional[str]' = None, region: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

authentication_type: AuthenticationType | None = None

cloud: str | None = None

Cloud vendor of the provider’s UC metastore. This field is only present when the __authentication_type__ is DATABRICKS.

comment: str | None = None

Description about the provider.

created_at: int | None = None

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

created_by: str | None = None

Username of Provider creator.

data_provider_global_metastore_id: str | None = None

The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is DATABRICKS. The identifier is of format __cloud__:__region__:__metastore-uuid__.

metastore_id: str | None = None

UUID of the provider’s UC metastore. This field is only present when the __authentication_type__ is DATABRICKS.

name: str | None = None

The name of the Provider.

owner: str | None = None

Username of Provider owner.

recipient_profile: RecipientProfile | None = None

The recipient profile. This field is only present when the authentication_type is TOKEN or OAUTH_CLIENT_CREDENTIALS.

recipient_profile_str: str | None = None

This field is required when the __authentication_type__ is TOKEN, OAUTH_CLIENT_CREDENTIALS or not provided.

region: str | None = None

Cloud region of the provider’s UC metastore. This field is only present when the __authentication_type__ is DATABRICKS.

updated_at: int | None = None

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

updated_by: str | None = None

Username of user who last modified Provider.

as_dict() → dict

Serializes the ProviderInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ProviderInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ProviderInfo

Deserializes the ProviderInfo from a dictionary.

class databricks.sdk.service.sharing.ProviderShare(name: 'Optional[str]' = None)

name: str | None = None

The name of the Provider Share.

as_dict() → dict

Serializes the ProviderShare into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ProviderShare into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ProviderShare

Deserializes the ProviderShare from a dictionary.

class databricks.sdk.service.sharing.RecipientInfo(activated: 'Optional[bool]' = None, activation_url: 'Optional[str]' = None, authentication_type: 'Optional[AuthenticationType]' = None, cloud: 'Optional[str]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, data_recipient_global_metastore_id: 'Optional[str]' = None, expiration_time: 'Optional[int]' = None, id: 'Optional[str]' = None, ip_access_list: 'Optional[IpAccessList]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, properties_kvpairs: 'Optional[SecurablePropertiesKvPairs]' = None, region: 'Optional[str]' = None, sharing_code: 'Optional[str]' = None, tokens: 'Optional[List[RecipientTokenInfo]]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

activated: bool | None = None

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

activation_url: str | None = None

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

authentication_type: AuthenticationType | None = None

cloud: str | None = None

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

comment: str | None = None

Description about the recipient.

created_at: int | None = None

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

created_by: str | None = None

Username of recipient creator.

data_recipient_global_metastore_id: str | None = None

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__.

expiration_time: int | None = None

Expiration timestamp of the token, in epoch milliseconds.

id: str | None = None

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

ip_access_list: IpAccessList | None = None

IP Access List

metastore_id: str | None = None

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

name: str | None = None

Name of Recipient.

owner: str | None = None

Username of the recipient owner.

properties_kvpairs: SecurablePropertiesKvPairs | None = None

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: str | None = None

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

sharing_code: str | None = None

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

tokens: List[RecipientTokenInfo] | None = None

This field is only present when the __authentication_type__ is TOKEN.

updated_at: int | None = None

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

updated_by: str | None = None

Username of recipient updater.

as_dict() → dict

Serializes the RecipientInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the RecipientInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → RecipientInfo

Deserializes the RecipientInfo from a dictionary.

class databricks.sdk.service.sharing.RecipientProfile(bearer_token: 'Optional[str]' = None, endpoint: 'Optional[str]' = None, share_credentials_version: 'Optional[int]' = None)

bearer_token: str | None = None

The token used to authorize the recipient.

endpoint: str | None = None

The endpoint for the share to be used by the recipient.

share_credentials_version: int | None = None

The version number of the recipient’s credentials on a share.

as_dict() → dict

Serializes the RecipientProfile into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the RecipientProfile into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → RecipientProfile

Deserializes the RecipientProfile from a dictionary.

class databricks.sdk.service.sharing.RecipientTokenInfo(activation_url: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, expiration_time: 'Optional[int]' = None, id: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

activation_url: str | None = None

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

created_at: int | None = None

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

created_by: str | None = None

Username of recipient token creator.

expiration_time: int | None = None

Expiration timestamp of the token in epoch milliseconds.

id: str | None = None

Unique ID of the recipient token.

updated_at: int | None = None

Time at which this recipient token was updated, in epoch milliseconds.

updated_by: str | None = None

Username of recipient token updater.

as_dict() → dict

Serializes the RecipientTokenInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the RecipientTokenInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → RecipientTokenInfo

Deserializes the RecipientTokenInfo from a dictionary.

class databricks.sdk.service.sharing.RegisteredModelAlias(alias_name: 'Optional[str]' = None, version_num: 'Optional[int]' = None)

alias_name: str | None = None

Name of the alias.

version_num: int | None = None

Numeric model version that alias will reference.

as_dict() → dict

Serializes the RegisteredModelAlias into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the RegisteredModelAlias into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → RegisteredModelAlias

Deserializes the RegisteredModelAlias from a dictionary.

class databricks.sdk.service.sharing.RetrieveTokenResponse(bearer_token: 'Optional[str]' = None, endpoint: 'Optional[str]' = None, expiration_time: 'Optional[str]' = None, share_credentials_version: 'Optional[int]' = None)

bearer_token: str | None = None

The token used to authorize the recipient.

endpoint: str | None = None

The endpoint for the share to be used by the recipient.

expiration_time: str | None = None

Expiration timestamp of the token in epoch milliseconds.

share_credentials_version: int | None = None

These field names must follow the delta sharing protocol.

as_dict() → dict

Serializes the RetrieveTokenResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the RetrieveTokenResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → RetrieveTokenResponse

Deserializes the RetrieveTokenResponse from a dictionary.

class databricks.sdk.service.sharing.SecurablePropertiesKvPairs(properties: Dict[str, str])

An object with __properties__ containing map of key-value properties attached to the securable.

properties: Dict[str, str]

A map of key-value properties attached to the securable.

as_dict() → dict

Serializes the SecurablePropertiesKvPairs into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SecurablePropertiesKvPairs into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SecurablePropertiesKvPairs

Deserializes the SecurablePropertiesKvPairs from a dictionary.

class databricks.sdk.service.sharing.Share(id: 'Optional[str]' = None, name: 'Optional[str]' = None)

id: str | None = None

name: str | None = None

as_dict() → dict

Serializes the Share into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Share into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Share

Deserializes the Share from a dictionary.

class databricks.sdk.service.sharing.ShareInfo(comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, name: 'Optional[str]' = None, objects: 'Optional[List[SharedDataObject]]' = None, owner: 'Optional[str]' = None, storage_location: 'Optional[str]' = None, storage_root: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

comment: str | None = None

User-provided free-form text description.

created_at: int | None = None

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

created_by: str | None = None

Username of share creator.

name: str | None = None

Name of the share.

objects: List[SharedDataObject] | None = None

A list of shared data objects within the share.

owner: str | None = None

Username of current owner of share.

storage_location: str | None = None

Storage Location URL (full path) for the share.

storage_root: str | None = None

Storage root URL for the share.

updated_at: int | None = None

Time at which this share was updated, in epoch milliseconds.

updated_by: str | None = None

Username of share updater.

as_dict() → dict

Serializes the ShareInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ShareInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ShareInfo

Deserializes the ShareInfo from a dictionary.

class databricks.sdk.service.sharing.ShareToPrivilegeAssignment(privilege_assignments: 'Optional[List[PrivilegeAssignment]]' = None, share_name: 'Optional[str]' = None)

privilege_assignments: List[PrivilegeAssignment] | None = None

The privileges assigned to the principal.

share_name: str | None = None

The share name.

as_dict() → dict

Serializes the ShareToPrivilegeAssignment into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ShareToPrivilegeAssignment into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ShareToPrivilegeAssignment

Deserializes the ShareToPrivilegeAssignment from a dictionary.

class databricks.sdk.service.sharing.SharedDataObject(name: 'str', added_at: 'Optional[int]' = None, added_by: 'Optional[str]' = None, cdf_enabled: 'Optional[bool]' = None, comment: 'Optional[str]' = None, content: 'Optional[str]' = None, data_object_type: 'Optional[SharedDataObjectDataObjectType]' = None, history_data_sharing_status: 'Optional[SharedDataObjectHistoryDataSharingStatus]' = None, partitions: 'Optional[List[Partition]]' = None, shared_as: 'Optional[str]' = None, start_version: 'Optional[int]' = None, status: 'Optional[SharedDataObjectStatus]' = None, string_shared_as: 'Optional[str]' = None)

name: str

A fully qualified name that uniquely identifies a data object. For example, a table’s fully qualified name is in the format of <catalog>.<schema>.<table>,

added_at: int | None = None

The time when this data object is added to the share, in epoch milliseconds.

added_by: str | None = None

Username of the sharer.

cdf_enabled: bool | None = None

Whether to enable cdf or indicate if cdf is enabled on the shared object.

comment: str | None = None

A user-provided comment when adding the data object to the share.

content: str | None = None

The content of the notebook file when the data object type is NOTEBOOK_FILE. This should be base64 encoded. Required for adding a NOTEBOOK_FILE, optional for updating, ignored for other types.

data_object_type: SharedDataObjectDataObjectType | None = None

The type of the data object.

history_data_sharing_status: SharedDataObjectHistoryDataSharingStatus | None = None

Whether to enable or disable sharing of data history. If not specified, the default is DISABLED.

partitions: List[Partition] | None = None

Array of partitions for the shared data.

shared_as: str | None = None

A user-provided alias name for table-like data objects within the share.

Use this field for table-like objects (for example: TABLE, VIEW, MATERIALIZED_VIEW, STREAMING_TABLE, FOREIGN_TABLE). For non-table objects (for example: VOLUME, MODEL, NOTEBOOK_FILE, FUNCTION), use string_shared_as instead.

Important: For non-table objects, this field must be omitted entirely.

Format: Must be a 2-part name <schema_name>.<table_name> (e.g., “sales_schema.orders_table”) - Both schema and table names must contain only alphanumeric characters and underscores - No periods, spaces, forward slashes, or control characters are allowed within each part - Do not include the catalog name (use 2 parts, not 3)

Behavior: - If not provided, the service automatically generates the alias as <schema>.<table> from the object’s original name - If you don’t want to specify this field, omit it entirely from the request (do not pass an empty string) - The shared_as name must be unique within the share

Examples: - Valid: “analytics_schema.customer_view” - Invalid: “catalog.analytics_schema.customer_view” (3 parts not allowed) - Invalid: “analytics-schema.customer-view” (hyphens not allowed)

start_version: int | None = None

The start version associated with the object. This allows data providers to control the lowest object version that is accessible by clients. If specified, clients can query snapshots or changes for versions >= start_version. If not specified, clients can only query starting from the version of the object at the time it was added to the share.

NOTE: The start_version should be <= the current version of the object.

status: SharedDataObjectStatus | None = None

One of: ACTIVE, PERMISSION_DENIED.

string_shared_as: str | None = None

A user-provided alias name for non-table data objects within the share.

Use this field for non-table objects (for example: VOLUME, MODEL, NOTEBOOK_FILE, FUNCTION). For table-like objects (for example: TABLE, VIEW, MATERIALIZED_VIEW, STREAMING_TABLE, FOREIGN_TABLE), use shared_as instead.

Important: For table-like objects, this field must be omitted entirely.

Format: - For VOLUME: Must be a 2-part name <schema_name>.<volume_name> (e.g., “data_schema.ml_models”) - For FUNCTION: Must be a 2-part name <schema_name>.<function_name> (e.g., “udf_schema.calculate_tax”) - For MODEL: Must be a 2-part name <schema_name>.<model_name> (e.g., “models.prediction_model”) - For NOTEBOOK_FILE: Should be the notebook file name (e.g., “analysis_notebook.py”) - All names must contain only alphanumeric characters and underscores - No periods, spaces, forward slashes, or control characters are allowed within each part

Behavior: - If not provided, the service automatically generates the alias from the object’s original name - If you don’t want to specify this field, omit it entirely from the request (do not pass an empty string) - The string_shared_as name must be unique for objects of the same type within the share

Examples: - Valid for VOLUME: “data_schema.training_data” - Valid for FUNCTION: “analytics.calculate_revenue” - Invalid: “catalog.data_schema.training_data” (3 parts not allowed for volumes) - Invalid: “data-schema.training-data” (hyphens not allowed)

as_dict() → dict

Serializes the SharedDataObject into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SharedDataObject into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SharedDataObject

Deserializes the SharedDataObject from a dictionary.

class databricks.sdk.service.sharing.SharedDataObjectDataObjectType

FEATURE_SPEC = "FEATURE_SPEC"

FOREIGN_TABLE = "FOREIGN_TABLE"

FUNCTION = "FUNCTION"

MATERIALIZED_VIEW = "MATERIALIZED_VIEW"

MODEL = "MODEL"

NOTEBOOK_FILE = "NOTEBOOK_FILE"

SCHEMA = "SCHEMA"

STREAMING_TABLE = "STREAMING_TABLE"

TABLE = "TABLE"

VIEW = "VIEW"

VOLUME = "VOLUME"

class databricks.sdk.service.sharing.SharedDataObjectHistoryDataSharingStatus

DISABLED = "DISABLED"

ENABLED = "ENABLED"

class databricks.sdk.service.sharing.SharedDataObjectStatus

ACTIVE = "ACTIVE"

PERMISSION_DENIED = "PERMISSION_DENIED"

class databricks.sdk.service.sharing.SharedDataObjectUpdate(action: 'Optional[SharedDataObjectUpdateAction]' = None, data_object: 'Optional[SharedDataObject]' = None)

action: SharedDataObjectUpdateAction | None = None

One of: ADD, REMOVE, UPDATE.

data_object: SharedDataObject | None = None

The data object that is being added, removed, or updated. The maximum number update data objects allowed is a 100.

as_dict() → dict

Serializes the SharedDataObjectUpdate into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SharedDataObjectUpdate into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SharedDataObjectUpdate

Deserializes the SharedDataObjectUpdate from a dictionary.

class databricks.sdk.service.sharing.SharedDataObjectUpdateAction

ADD = "ADD"

REMOVE = "REMOVE"

UPDATE = "UPDATE"

class databricks.sdk.service.sharing.SharedSecurableKind

The SecurableKind of a delta-shared object.

FUNCTION_FEATURE_SPEC = "FUNCTION_FEATURE_SPEC"

FUNCTION_REGISTERED_MODEL = "FUNCTION_REGISTERED_MODEL"

FUNCTION_STANDARD = "FUNCTION_STANDARD"

class databricks.sdk.service.sharing.Table(comment: 'Optional[str]' = None, id: 'Optional[str]' = None, materialization_namespace: 'Optional[str]' = None, materialized_table_name: 'Optional[str]' = None, name: 'Optional[str]' = None, schema: 'Optional[str]' = None, share: 'Optional[str]' = None, share_id: 'Optional[str]' = None, tags: 'Optional[List[catalog.TagKeyValue]]' = None)

comment: str | None = None

The comment of the table.

id: str | None = None

The id of the table.

materialization_namespace: str | None = None

The catalog and schema of the materialized table

materialized_table_name: str | None = None

The name of a materialized table.

name: str | None = None

The name of the table.

schema: str | None = None

The name of the schema that the table belongs to.

share: str | None = None

The name of the share that the table belongs to.

share_id: str | None = None

The id of the share that the table belongs to.

tags: List[TagKeyValue] | None = None

The Tags of the table.

as_dict() → dict

Serializes the Table into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Table into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Table

Deserializes the Table from a dictionary.

class databricks.sdk.service.sharing.UpdateSharePermissionsResponse(privilege_assignments: 'Optional[List[PrivilegeAssignment]]' = None)

privilege_assignments: List[PrivilegeAssignment] | None = None

The privileges assigned to each principal

as_dict() → dict

Serializes the UpdateSharePermissionsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UpdateSharePermissionsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UpdateSharePermissionsResponse

Deserializes the UpdateSharePermissionsResponse from a dictionary.

class databricks.sdk.service.sharing.Volume(comment: 'Optional[str]' = None, id: 'Optional[str]' = None, name: 'Optional[str]' = None, schema: 'Optional[str]' = None, share: 'Optional[str]' = None, share_id: 'Optional[str]' = None, tags: 'Optional[List[catalog.TagKeyValue]]' = None)

comment: str | None = None

The comment of the volume.

id: str | None = None

This id maps to the shared_volume_id in database Recipient needs shared_volume_id for recon to check if this volume is already in recipient’s DB or not.

name: str | None = None

The name of the volume.

schema: str | None = None

The name of the schema that the volume belongs to.

share: str | None = None

The name of the share that the volume belongs to.

share_id: str | None = None

/ The id of the share that the volume belongs to.

tags: List[TagKeyValue] | None = None

The tags of the volume.

as_dict() → dict

Serializes the Volume into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Volume into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Volume

Deserializes the Volume from a dictionary.