Unity Catalog

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

class databricks.sdk.service.catalog.AccessRequestDestinations(securable: 'Securable', are_any_destinations_hidden: 'Optional[bool]' = None, destination_source_securable: 'Optional[Securable]' = None, destinations: 'Optional[List[NotificationDestination]]' = None, full_name: 'Optional[str]' = None, securable_type: 'Optional[str]' = None)

securable: Securable

The securable for which the access request destinations are being modified or read.

are_any_destinations_hidden: bool | None = None

Indicates whether any destinations are hidden from the caller due to a lack of permissions. This value is true if the caller does not have permission to see all destinations.

destination_source_securable: Securable | None = None

The source securable from which the destinations are inherited. Either the same value as securable (if destination is set directly on the securable) or the nearest parent securable with destinations set.

destinations: List[NotificationDestination] | None = None

The access request destinations for the securable.

full_name: str | None = None

The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration

securable_type: str | None = None

The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccessRequestDestinations from a dictionary.

class databricks.sdk.service.catalog.AccountsCreateMetastoreAssignmentResponse

The metastore assignment was successfully created.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsCreateMetastoreAssignmentResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsCreateMetastoreResponse(metastore_info: 'Optional[MetastoreInfo]' = None)

metastore_info: MetastoreInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsCreateMetastoreResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsCreateStorageCredentialInfo(credential_info: 'Optional[StorageCredentialInfo]' = None)

credential_info: StorageCredentialInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsCreateStorageCredentialInfo from a dictionary.

class databricks.sdk.service.catalog.AccountsDeleteMetastoreAssignmentResponse

The metastore assignment was successfully deleted.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsDeleteMetastoreAssignmentResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsDeleteMetastoreResponse

The metastore was successfully deleted.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsDeleteMetastoreResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsDeleteStorageCredentialResponse

The storage credential was successfully deleted.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsDeleteStorageCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsGetMetastoreResponse(metastore_info: MetastoreInfo | None = None)

The metastore was successfully returned.

metastore_info: MetastoreInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsGetMetastoreResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsListMetastoresResponse(metastores: List[MetastoreInfo] | None = None)

Metastores were returned successfully.

metastores: List[MetastoreInfo] | None = None

An array of metastore information objects.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsListMetastoresResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsMetastoreAssignment(metastore_assignment: MetastoreAssignment | None = None)

The workspace metastore assignment was successfully returned.

metastore_assignment: MetastoreAssignment | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.AccountsStorageCredentialInfo(credential_info: StorageCredentialInfo | None = None)

The storage credential was successfully retrieved.

credential_info: StorageCredentialInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsStorageCredentialInfo from a dictionary.

class databricks.sdk.service.catalog.AccountsUpdateMetastoreAssignmentResponse

The metastore assignment was successfully updated.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsUpdateMetastoreAssignmentResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsUpdateMetastoreResponse(metastore_info: MetastoreInfo | None = None)

The metastore update request succeeded.

metastore_info: MetastoreInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsUpdateMetastoreResponse from a dictionary.

class databricks.sdk.service.catalog.AccountsUpdateStorageCredentialResponse(credential_info: StorageCredentialInfo | None = None)

The storage credential was successfully updated.

credential_info: StorageCredentialInfo | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AccountsUpdateStorageCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.ArtifactAllowlistInfo(artifact_matchers: 'Optional[List[ArtifactMatcher]]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None)

artifact_matchers: List[ArtifactMatcher] | None = None

A list of allowed artifact match patterns.

created_at: int | None = None

Time at which this artifact allowlist was set, in epoch milliseconds.

created_by: str | None = None

Username of the user who set the artifact allowlist.

metastore_id: str | None = None

Unique identifier of parent metastore.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ArtifactAllowlistInfo from a dictionary.

class databricks.sdk.service.catalog.ArtifactMatcher(artifact: 'str', match_type: 'MatchType')

artifact: str

The artifact path or maven coordinate

match_type: MatchType

The pattern matching type of the artifact

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ArtifactMatcher from a dictionary.

class databricks.sdk.service.catalog.ArtifactType

The artifact type

INIT_SCRIPT = "INIT_SCRIPT"

LIBRARY_JAR = "LIBRARY_JAR"

LIBRARY_MAVEN = "LIBRARY_MAVEN"

class databricks.sdk.service.catalog.AssignResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AssignResponse from a dictionary.

class databricks.sdk.service.catalog.AwsCredentials(access_key_id: str | None = None, access_point: str | None = None, secret_access_key: str | None = None, session_token: str | None = None)

AWS temporary credentials for API authentication. Read more at https://docs.aws.amazon.com/STS/latest/APIReference/API_Credentials.html.

access_key_id: str | None = None

The access key ID that identifies the temporary credentials.

access_point: str | None = None

The Amazon Resource Name (ARN) of the S3 access point for temporary credentials related the external location.

secret_access_key: str | None = None

The secret access key that can be used to sign AWS API requests.

session_token: str | None = None

The token that users must pass to AWS API to use the temporary credentials.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsCredentials from a dictionary.

class databricks.sdk.service.catalog.AwsIamRole(external_id: str | None = None, role_arn: str | None = None, unity_catalog_iam_arn: str | None = None)

The AWS IAM role configuration

external_id: str | None = None

The external ID used in role assumption to prevent the confused deputy problem.

role_arn: str | None = None

The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials.

unity_catalog_iam_arn: str | None = None

The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsIamRole from a dictionary.

class databricks.sdk.service.catalog.AwsIamRoleRequest(role_arn: str)

The AWS IAM role configuration

role_arn: str

The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsIamRoleRequest from a dictionary.

class databricks.sdk.service.catalog.AwsIamRoleResponse(role_arn: str, external_id: str | None = None, unity_catalog_iam_arn: str | None = None)

The AWS IAM role configuration

role_arn: str

The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials.

external_id: str | None = None

The external ID used in role assumption to prevent the confused deputy problem.

unity_catalog_iam_arn: str | None = None

The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsIamRoleResponse from a dictionary.

class databricks.sdk.service.catalog.AwsSqsQueue(managed_resource_id: 'Optional[str]' = None, queue_url: 'Optional[str]' = None)

managed_resource_id: str | None = None

Unique identifier included in the name of file events managed cloud resources.

queue_url: str | None = None

The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}. Only required for provided_sqs.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AwsSqsQueue from a dictionary.

class databricks.sdk.service.catalog.AzureActiveDirectoryToken(aad_token: str | None = None)

Azure Active Directory token, essentially the Oauth token for Azure Service Principal or Managed Identity. Read more at https://learn.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/aad/service-prin-aad-token

aad_token: str | None = None

Opaque token that contains claims that you can use in Azure Active Directory to access cloud services.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureActiveDirectoryToken from a dictionary.

class databricks.sdk.service.catalog.AzureEncryptionSettings(azure_tenant_id: 'str', azure_cmk_access_connector_id: 'Optional[str]' = None, azure_cmk_managed_identity_id: 'Optional[str]' = None)

azure_tenant_id: str

azure_cmk_access_connector_id: str | None = None

azure_cmk_managed_identity_id: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureEncryptionSettings from a dictionary.

class databricks.sdk.service.catalog.AzureManagedIdentity(access_connector_id: str, credential_id: str | None = None, managed_identity_id: str | None = None)

The Azure managed identity configuration.

access_connector_id: str

The Azure resource ID of the Azure Databricks Access Connector. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}.

credential_id: str | None = None

The Databricks internal ID that represents this managed identity.

managed_identity_id: str | None = None

The Azure resource ID of the managed identity. Use the format, /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name} This is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity. If this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureManagedIdentity from a dictionary.

class databricks.sdk.service.catalog.AzureManagedIdentityRequest(access_connector_id: str, managed_identity_id: str | None = None)

The Azure managed identity configuration.

access_connector_id: str

The Azure resource ID of the Azure Databricks Access Connector. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}.

managed_identity_id: str | None = None

The Azure resource ID of the managed identity. Use the format, /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name} This is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity. If this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureManagedIdentityRequest from a dictionary.

class databricks.sdk.service.catalog.AzureManagedIdentityResponse(access_connector_id: str, credential_id: str | None = None, managed_identity_id: str | None = None)

The Azure managed identity configuration.

access_connector_id: str

The Azure resource ID of the Azure Databricks Access Connector. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}.

credential_id: str | None = None

The Databricks internal ID that represents this managed identity.

managed_identity_id: str | None = None

The Azure resource ID of the managed identity. Use the format, /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name} This is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity. If this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureManagedIdentityResponse from a dictionary.

class databricks.sdk.service.catalog.AzureQueueStorage(managed_resource_id: 'Optional[str]' = None, queue_url: 'Optional[str]' = None, resource_group: 'Optional[str]' = None, subscription_id: 'Optional[str]' = None)

managed_resource_id: str | None = None

Unique identifier included in the name of file events managed cloud resources.

queue_url: str | None = None

The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name} Only required for provided_aqs.

resource_group: str | None = None

Optional resource group for the queue, event grid subscription, and external location storage account. Only required for locations with a service principal storage credential

subscription_id: str | None = None

Optional subscription id for the queue, event grid subscription, and external location storage account. Required for locations with a service principal storage credential

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureQueueStorage from a dictionary.

class databricks.sdk.service.catalog.AzureServicePrincipal(directory_id: str, application_id: str, client_secret: str)

The Azure service principal configuration. Only applicable when purpose is STORAGE.

directory_id: str

The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application.

application_id: str

The application ID of the application registration within the referenced AAD tenant.

client_secret: str

The client secret generated for the above app ID in AAD.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureServicePrincipal from a dictionary.

class databricks.sdk.service.catalog.AzureUserDelegationSas(sas_token: str | None = None)

Azure temporary credentials for API authentication. Read more at https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas

sas_token: str | None = None

The signed URI (SAS Token) used to access blob services for a given path

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AzureUserDelegationSas from a dictionary.

class databricks.sdk.service.catalog.BatchCreateAccessRequestsResponse(responses: 'Optional[List[CreateAccessRequestResponse]]' = None)

responses: List[CreateAccessRequestResponse] | None = None

The access request destinations for each securable object the principal requested.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the BatchCreateAccessRequestsResponse from a dictionary.

class databricks.sdk.service.catalog.CancelRefreshResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CancelRefreshResponse from a dictionary.

class databricks.sdk.service.catalog.CatalogInfo(browse_only: 'Optional[bool]' = None, catalog_type: 'Optional[CatalogType]' = None, comment: 'Optional[str]' = None, connection_name: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, effective_predictive_optimization_flag: 'Optional[EffectivePredictiveOptimizationFlag]' = None, enable_predictive_optimization: 'Optional[EnablePredictiveOptimization]' = None, full_name: 'Optional[str]' = None, isolation_mode: 'Optional[CatalogIsolationMode]' = None, managed_encryption_settings: 'Optional[EncryptionSettings]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, options: 'Optional[Dict[str, str]]' = None, owner: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None, provider_name: 'Optional[str]' = None, provisioning_info: 'Optional[ProvisioningInfo]' = None, securable_type: 'Optional[SecurableType]' = None, share_name: 'Optional[str]' = None, storage_location: 'Optional[str]' = None, storage_root: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_type: CatalogType | None = None

comment: str | None = None

User-provided free-form text description.

connection_name: str | None = None

The name of the connection to an external data source.

created_at: int | None = None

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

created_by: str | None = None

Username of catalog creator.

effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None

enable_predictive_optimization: EnablePredictiveOptimization | None = None

Whether predictive optimization should be enabled for this object and objects under it.

full_name: str | None = None

The full name of the catalog. Corresponds with the name field.

isolation_mode: CatalogIsolationMode | None = None

Whether the current securable is accessible from all workspaces or a specific set of workspaces.

managed_encryption_settings: EncryptionSettings | None = None

Control CMK encryption for managed catalog data

metastore_id: str | None = None

Unique identifier of parent metastore.

name: str | None = None

Name of catalog.

options: Dict[str, str] | None = None

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

owner: str | None = None

Username of current owner of catalog.

properties: Dict[str, str] | None = None

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

provider_name: str | None = None

The name of delta sharing provider.

A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.

provisioning_info: ProvisioningInfo | None = None

securable_type: SecurableType | None = None

share_name: str | None = None

The name of the share under the share provider.

storage_location: str | None = None

Storage Location URL (full path) for managed tables within catalog.

storage_root: str | None = None

Storage root URL for managed tables within catalog.

updated_at: int | None = None

Time at which this catalog was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified catalog.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CatalogInfo from a dictionary.

class databricks.sdk.service.catalog.CatalogIsolationMode

ISOLATED = "ISOLATED"

OPEN = "OPEN"

class databricks.sdk.service.catalog.CatalogType

The type of the catalog.

DELTASHARING_CATALOG = "DELTASHARING_CATALOG"

FOREIGN_CATALOG = "FOREIGN_CATALOG"

INTERNAL_CATALOG = "INTERNAL_CATALOG"

MANAGED_CATALOG = "MANAGED_CATALOG"

MANAGED_ONLINE_CATALOG = "MANAGED_ONLINE_CATALOG"

SYSTEM_CATALOG = "SYSTEM_CATALOG"

class databricks.sdk.service.catalog.CloudflareApiToken(access_key_id: str, secret_access_key: str, account_id: str | None = None)

The Cloudflare API token configuration. Read more at https://developers.cloudflare.com/r2/api/s3/tokens/

access_key_id: str

The access key ID associated with the API token.

secret_access_key: str

The secret access token generated for the above access key ID.

account_id: str | None = None

The ID of the account associated with the API token.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CloudflareApiToken from a dictionary.

class databricks.sdk.service.catalog.ColumnInfo(comment: 'Optional[str]' = None, mask: 'Optional[ColumnMask]' = None, name: 'Optional[str]' = None, nullable: 'Optional[bool]' = None, partition_index: 'Optional[int]' = None, position: 'Optional[int]' = None, type_interval_type: 'Optional[str]' = None, type_json: 'Optional[str]' = None, type_name: 'Optional[ColumnTypeName]' = None, type_precision: 'Optional[int]' = None, type_scale: 'Optional[int]' = None, type_text: 'Optional[str]' = None)

comment: str | None = None

User-provided free-form text description.

mask: ColumnMask | None = None

name: str | None = None

Name of Column.

nullable: bool | None = None

Whether field may be Null (default: true).

partition_index: int | None = None

Partition index for column.

position: int | None = None

Ordinal position of column (starting at position 0).

type_interval_type: str | None = None

Format of IntervalType.

type_json: str | None = None

Full data type specification, JSON-serialized.

type_name: ColumnTypeName | None = None

type_precision: int | None = None

Digits of precision; required for DecimalTypes.

type_scale: int | None = None

Digits to right of decimal; Required for DecimalTypes.

type_text: str | None = None

Full data type specification as SQL/catalogString text.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ColumnInfo from a dictionary.

class databricks.sdk.service.catalog.ColumnMask(function_name: 'Optional[str]' = None, using_arguments: 'Optional[List[PolicyFunctionArgument]]' = None, using_column_names: 'Optional[List[str]]' = None)

function_name: str | None = None

The full name of the column mask SQL UDF.

using_arguments: List[PolicyFunctionArgument] | None = None

The list of additional table columns or literals to be passed as additional arguments to a column mask function. This is the replacement of the deprecated using_column_names field and carries information about the types (alias or constant) of the arguments to the mask function.

using_column_names: List[str] | None = None

The list of additional table columns to be passed as input to the column mask function. The first arg of the mask function should be of the type of the column being masked and the types of the rest of the args should match the types of columns in ‘using_column_names’.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ColumnMask from a dictionary.

class databricks.sdk.service.catalog.ColumnMaskOptions(function_name: 'str', on_column: 'str', using: 'Optional[List[FunctionArgument]]' = None)

function_name: str

The fully qualified name of the column mask function. The function is called on each row of the target table. The function’s first argument and its return type should match the type of the masked column. Required on create and update.

on_column: str

The alias of the column to be masked. The alias must refer to one of matched columns. The values of the column is passed to the column mask function as the first argument. Required on create and update.

using: List[FunctionArgument] | None = None

Optional list of column aliases or constant literals to be passed as additional arguments to the column mask function. The type of each column should match the positional argument of the column mask function.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ColumnMaskOptions from a dictionary.

class databricks.sdk.service.catalog.ColumnRelationship(source: 'Optional[str]' = None, target: 'Optional[str]' = None)

source: str | None = None

target: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ColumnRelationship from a dictionary.

class databricks.sdk.service.catalog.ColumnTypeName

ARRAY = "ARRAY"

BINARY = "BINARY"

BOOLEAN = "BOOLEAN"

BYTE = "BYTE"

CHAR = "CHAR"

DATE = "DATE"

DECIMAL = "DECIMAL"

DOUBLE = "DOUBLE"

FLOAT = "FLOAT"

GEOGRAPHY = "GEOGRAPHY"

GEOMETRY = "GEOMETRY"

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.catalog.ConnectionDependency(connection_name: str | None = None)

A connection that is dependent on a SQL object.

connection_name: str | None = None

Full name of the dependent connection, in the form of __connection_name__.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ConnectionDependency from a dictionary.

class databricks.sdk.service.catalog.ConnectionInfo(comment: 'Optional[str]' = None, connection_id: 'Optional[str]' = None, connection_type: 'Optional[ConnectionType]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, credential_type: 'Optional[CredentialType]' = None, full_name: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, options: 'Optional[Dict[str, str]]' = None, owner: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None, provisioning_info: 'Optional[ProvisioningInfo]' = None, read_only: 'Optional[bool]' = None, securable_type: 'Optional[SecurableType]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, url: 'Optional[str]' = None)

comment: str | None = None

User-provided free-form text description.

connection_id: str | None = None

Unique identifier of the Connection.

connection_type: ConnectionType | None = None

The type of connection.

created_at: int | None = None

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

created_by: str | None = None

Username of connection creator.

credential_type: CredentialType | None = None

The type of credential.

full_name: str | None = None

Full name of connection.

metastore_id: str | None = None

Unique identifier of parent metastore.

name: str | None = None

Name of the connection.

options: Dict[str, str] | None = None

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

owner: str | None = None

Username of current owner of the connection.

properties: Dict[str, str] | None = None

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

provisioning_info: ProvisioningInfo | None = None

read_only: bool | None = None

If the connection is read only.

securable_type: SecurableType | None = None

updated_at: int | None = None

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

updated_by: str | None = None

Username of user who last modified connection.

url: str | None = None

URL of the remote data source, extracted from options.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ConnectionInfo from a dictionary.

class databricks.sdk.service.catalog.ConnectionType

Next Id: 126

BIGQUERY = "BIGQUERY"

CONFLUENCE = "CONFLUENCE"

DATABRICKS = "DATABRICKS"

GA4_RAW_DATA = "GA4_RAW_DATA"

GITHUB = "GITHUB"

GLUE = "GLUE"

HIVE_METASTORE = "HIVE_METASTORE"

HTTP = "HTTP"

HUBSPOT = "HUBSPOT"

META_MARKETING = "META_MARKETING"

MYSQL = "MYSQL"

ORACLE = "ORACLE"

OUTLOOK = "OUTLOOK"

POSTGRESQL = "POSTGRESQL"

POWER_BI = "POWER_BI"

REDSHIFT = "REDSHIFT"

SALESFORCE = "SALESFORCE"

SALESFORCE_DATA_CLOUD = "SALESFORCE_DATA_CLOUD"

SERVICENOW = "SERVICENOW"

SMARTSHEET = "SMARTSHEET"

SNOWFLAKE = "SNOWFLAKE"

SQLDW = "SQLDW"

SQLSERVER = "SQLSERVER"

TERADATA = "TERADATA"

UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE"

WORKDAY_RAAS = "WORKDAY_RAAS"

ZENDESK = "ZENDESK"

class databricks.sdk.service.catalog.ContinuousUpdateStatus(initial_pipeline_sync_progress: PipelineProgress | None = None, last_processed_commit_version: int | None = None, timestamp: str | None = None)

Detailed status of an online table. Shown if the online table is in the ONLINE_CONTINUOUS_UPDATE or the ONLINE_UPDATING_PIPELINE_RESOURCES state.

initial_pipeline_sync_progress: PipelineProgress | None = None

Progress of the initial data synchronization.

last_processed_commit_version: int | None = None

The last source table Delta version that was synced to the online table. Note that this Delta version may not be completely synced to the online table yet.

timestamp: str | None = None

The timestamp of the last time any data was synchronized from the source table to the online table.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ContinuousUpdateStatus from a dictionary.

class databricks.sdk.service.catalog.CreateAccessRequest(behalf_of: 'Optional[Principal]' = None, comment: 'Optional[str]' = None, securable_permissions: 'Optional[List[SecurablePermissions]]' = None)

behalf_of: Principal | None = None

Optional. The principal this request is for. Empty behalf_of defaults to the requester’s identity.

Principals must be unique across the API call.

comment: str | None = None

Optional. Comment associated with the request.

At most 200 characters, can only contain lowercase/uppercase letters (a-z, A-Z), numbers (0-9), punctuation, and spaces.

securable_permissions: List[SecurablePermissions] | None = None

List of securables and their corresponding requested UC privileges.

At most 30 securables can be requested for a principal per batched call. Each securable can only be requested once per principal.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateAccessRequest from a dictionary.

class databricks.sdk.service.catalog.CreateAccessRequestResponse(behalf_of: 'Optional[Principal]' = None, request_destinations: 'Optional[List[AccessRequestDestinations]]' = None)

behalf_of: Principal | None = None

The principal the request was made on behalf of.

request_destinations: List[AccessRequestDestinations] | None = None

The access request destinations for all the securables the principal requested.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateAccessRequestResponse from a dictionary.

class databricks.sdk.service.catalog.CreateAccountsMetastore(name: 'str', external_access_enabled: 'Optional[bool]' = None, region: 'Optional[str]' = None, storage_root: 'Optional[str]' = None)

name: str

The user-specified name of the metastore.

external_access_enabled: bool | None = None

Whether to allow non-DBR clients to directly access entities under the metastore.

region: str | None = None

Cloud region which the metastore serves (e.g., us-west-2, westus).

storage_root: str | None = None

The storage root URL for metastore

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateAccountsMetastore from a dictionary.

class databricks.sdk.service.catalog.CreateAccountsStorageCredential(name: 'str', aws_iam_role: 'Optional[AwsIamRoleRequest]' = None, azure_managed_identity: 'Optional[AzureManagedIdentityRequest]' = None, azure_service_principal: 'Optional[AzureServicePrincipal]' = None, cloudflare_api_token: 'Optional[CloudflareApiToken]' = None, comment: 'Optional[str]' = None, databricks_gcp_service_account: 'Optional[DatabricksGcpServiceAccountRequest]' = None, read_only: 'Optional[bool]' = None)

name: str

The credential name. The name must be unique among storage and service credentials within the metastore.

aws_iam_role: AwsIamRoleRequest | None = None

The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentityRequest | None = None

The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None

The Azure service principal configuration.

cloudflare_api_token: CloudflareApiToken | None = None

The Cloudflare API token configuration.

comment: str | None = None

Comment associated with the credential.

databricks_gcp_service_account: DatabricksGcpServiceAccountRequest | None = None

The Databricks managed GCP service account configuration.

read_only: bool | None = None

Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateAccountsStorageCredential from a dictionary.

class databricks.sdk.service.catalog.CreateFunction(name: 'str', catalog_name: 'str', schema_name: 'str', input_params: 'FunctionParameterInfos', data_type: 'ColumnTypeName', full_data_type: 'str', routine_body: 'CreateFunctionRoutineBody', routine_definition: 'str', parameter_style: 'CreateFunctionParameterStyle', is_deterministic: 'bool', sql_data_access: 'CreateFunctionSqlDataAccess', is_null_call: 'bool', security_type: 'CreateFunctionSecurityType', specific_name: 'str', comment: 'Optional[str]' = None, external_language: 'Optional[str]' = None, external_name: 'Optional[str]' = None, properties: 'Optional[str]' = None, return_params: 'Optional[FunctionParameterInfos]' = None, routine_dependencies: 'Optional[DependencyList]' = None, sql_path: 'Optional[str]' = None)

name: str

Name of function, relative to parent schema.

catalog_name: str

Name of parent Catalog.

schema_name: str

Name of parent Schema relative to its parent Catalog.

input_params: FunctionParameterInfos

Function input parameters.

data_type: ColumnTypeName

Scalar function return data type.

full_data_type: str

Pretty printed function data type.

routine_body: CreateFunctionRoutineBody

Function language. When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.

routine_definition: str

Function body.

parameter_style: CreateFunctionParameterStyle

Function parameter style. S is the value for SQL.

is_deterministic: bool

Whether the function is deterministic.

sql_data_access: CreateFunctionSqlDataAccess

Function SQL data access.

is_null_call: bool

Function null call.

security_type: CreateFunctionSecurityType

Function security type.

specific_name: str

Specific name of the function; Reserved for future use.

comment: str | None = None

User-provided free-form text description.

external_language: str | None = None

External function language.

external_name: str | None = None

External function name.

properties: str | None = None

JSON-serialized key-value pair map, encoded (escaped) as a string.

return_params: FunctionParameterInfos | None = None

Table function return parameters.

routine_dependencies: DependencyList | None = None

function dependencies.

sql_path: str | None = None

List of schemes whose objects can be referenced without qualification.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateFunction from a dictionary.

class databricks.sdk.service.catalog.CreateFunctionParameterStyle

S = "S"

class databricks.sdk.service.catalog.CreateFunctionRoutineBody

EXTERNAL = "EXTERNAL"

SQL = "SQL"

class databricks.sdk.service.catalog.CreateFunctionSecurityType

DEFINER = "DEFINER"

class databricks.sdk.service.catalog.CreateFunctionSqlDataAccess

CONTAINS_SQL = "CONTAINS_SQL"

NO_SQL = "NO_SQL"

READS_SQL_DATA = "READS_SQL_DATA"

class databricks.sdk.service.catalog.CreateMetastoreAssignment(workspace_id: 'int', metastore_id: 'str', default_catalog_name: 'str')

workspace_id: int

A workspace ID.

metastore_id: str

The unique ID of the metastore.

default_catalog_name: str

The name of the default catalog in the metastore. This field is deprecated. Please use “Default Namespace API” to configure the default catalog for a Databricks workspace.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.CreateRequestExternalLineage(source: 'ExternalLineageObject', target: 'ExternalLineageObject', columns: 'Optional[List[ColumnRelationship]]' = None, id: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None)

source: ExternalLineageObject

Source object of the external lineage relationship.

target: ExternalLineageObject

Target object of the external lineage relationship.

columns: List[ColumnRelationship] | None = None

List of column relationships between source and target objects.

id: str | None = None

Unique identifier of the external lineage relationship.

properties: Dict[str, str] | None = None

Key-value properties associated with the external lineage relationship.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CreateRequestExternalLineage from a dictionary.

class databricks.sdk.service.catalog.CredentialDependency(credential_name: str | None = None)

A credential that is dependent on a SQL object.

credential_name: str | None = None

Full name of the dependent credential, in the form of __credential_name__.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CredentialDependency from a dictionary.

class databricks.sdk.service.catalog.CredentialInfo(aws_iam_role: 'Optional[AwsIamRole]' = None, azure_managed_identity: 'Optional[AzureManagedIdentity]' = None, azure_service_principal: 'Optional[AzureServicePrincipal]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, databricks_gcp_service_account: 'Optional[DatabricksGcpServiceAccount]' = None, full_name: 'Optional[str]' = None, id: 'Optional[str]' = None, isolation_mode: 'Optional[IsolationMode]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, purpose: 'Optional[CredentialPurpose]' = None, read_only: 'Optional[bool]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, used_for_managed_storage: 'Optional[bool]' = None)

aws_iam_role: AwsIamRole | None = None

The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentity | None = None

The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None

The Azure service principal configuration.

comment: str | None = None

Comment associated with the credential.

created_at: int | None = None

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

created_by: str | None = None

Username of credential creator.

databricks_gcp_service_account: DatabricksGcpServiceAccount | None = None

The Databricks managed GCP service account configuration.

full_name: str | None = None

The full name of the credential.

id: str | None = None

The unique identifier of the credential.

isolation_mode: IsolationMode | None = None

Whether the current securable is accessible from all workspaces or a specific set of workspaces.

metastore_id: str | None = None

Unique identifier of the parent metastore.

name: str | None = None

The credential name. The name must be unique among storage and service credentials within the metastore.

owner: str | None = None

Username of current owner of credential.

purpose: CredentialPurpose | None = None

Indicates the purpose of the credential.

read_only: bool | None = None

Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE.

updated_at: int | None = None

Time at which this credential was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the credential.

used_for_managed_storage: bool | None = None

Whether this credential is the current metastore’s root storage credential. Only applicable when purpose is STORAGE.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CredentialInfo from a dictionary.

class databricks.sdk.service.catalog.CredentialPurpose

SERVICE = "SERVICE"

STORAGE = "STORAGE"

class databricks.sdk.service.catalog.CredentialType

Next Id: 19

ANY_STATIC_CREDENTIAL = "ANY_STATIC_CREDENTIAL"

BEARER_TOKEN = "BEARER_TOKEN"

EDGEGRID_AKAMAI = "EDGEGRID_AKAMAI"

OAUTH_ACCESS_TOKEN = "OAUTH_ACCESS_TOKEN"

OAUTH_M2M = "OAUTH_M2M"

OAUTH_MTLS = "OAUTH_MTLS"

OAUTH_REFRESH_TOKEN = "OAUTH_REFRESH_TOKEN"

OAUTH_RESOURCE_OWNER_PASSWORD = "OAUTH_RESOURCE_OWNER_PASSWORD"

OAUTH_U2M = "OAUTH_U2M"

OAUTH_U2M_MAPPING = "OAUTH_U2M_MAPPING"

OIDC_TOKEN = "OIDC_TOKEN"

PEM_PRIVATE_KEY = "PEM_PRIVATE_KEY"

SERVICE_CREDENTIAL = "SERVICE_CREDENTIAL"

SSWS_TOKEN = "SSWS_TOKEN"

UNKNOWN_CREDENTIAL_TYPE = "UNKNOWN_CREDENTIAL_TYPE"

USERNAME_PASSWORD = "USERNAME_PASSWORD"

class databricks.sdk.service.catalog.CredentialValidationResult(message: 'Optional[str]' = None, result: 'Optional[ValidateCredentialResult]' = None)

message: str | None = None

Error message would exist when the result does not equal to PASS.

result: ValidateCredentialResult | None = None

The results of the tested operation.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CredentialValidationResult from a dictionary.

class databricks.sdk.service.catalog.DataSourceFormat

Data source format

AVRO = "AVRO"

BIGQUERY_FORMAT = "BIGQUERY_FORMAT"

CSV = "CSV"

DATABRICKS_FORMAT = "DATABRICKS_FORMAT"

DATABRICKS_ROW_STORE_FORMAT = "DATABRICKS_ROW_STORE_FORMAT"

DELTA = "DELTA"

DELTASHARING = "DELTASHARING"

DELTA_UNIFORM_HUDI = "DELTA_UNIFORM_HUDI"

DELTA_UNIFORM_ICEBERG = "DELTA_UNIFORM_ICEBERG"

HIVE = "HIVE"

ICEBERG = "ICEBERG"

JSON = "JSON"

MONGODB_FORMAT = "MONGODB_FORMAT"

MYSQL_FORMAT = "MYSQL_FORMAT"

NETSUITE_FORMAT = "NETSUITE_FORMAT"

ORACLE_FORMAT = "ORACLE_FORMAT"

ORC = "ORC"

PARQUET = "PARQUET"

POSTGRESQL_FORMAT = "POSTGRESQL_FORMAT"

REDSHIFT_FORMAT = "REDSHIFT_FORMAT"

SALESFORCE_DATA_CLOUD_FORMAT = "SALESFORCE_DATA_CLOUD_FORMAT"

SALESFORCE_FORMAT = "SALESFORCE_FORMAT"

SNOWFLAKE_FORMAT = "SNOWFLAKE_FORMAT"

SQLDW_FORMAT = "SQLDW_FORMAT"

SQLSERVER_FORMAT = "SQLSERVER_FORMAT"

TERADATA_FORMAT = "TERADATA_FORMAT"

TEXT = "TEXT"

UNITY_CATALOG = "UNITY_CATALOG"

VECTOR_INDEX_FORMAT = "VECTOR_INDEX_FORMAT"

WORKDAY_RAAS_FORMAT = "WORKDAY_RAAS_FORMAT"

class databricks.sdk.service.catalog.DatabricksGcpServiceAccount(credential_id: str | None = None, email: str | None = None, private_key_id: str | None = None)

GCP long-lived credential. Databricks-created Google Cloud Storage service account.

credential_id: str | None = None

The Databricks internal ID that represents this managed identity.

email: str | None = None

The email of the service account.

private_key_id: str | None = None

The ID that represents the private key for this Service Account

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DatabricksGcpServiceAccount from a dictionary.

class databricks.sdk.service.catalog.DatabricksGcpServiceAccountRequest

GCP long-lived credential. Databricks-created Google Cloud Storage service account.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DatabricksGcpServiceAccountRequest from a dictionary.

class databricks.sdk.service.catalog.DatabricksGcpServiceAccountResponse(credential_id: str | None = None, email: str | None = None)

GCP long-lived credential. Databricks-created Google Cloud Storage service account.

credential_id: str | None = None

The Databricks internal ID that represents this managed identity.

email: str | None = None

The email of the service account.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DatabricksGcpServiceAccountResponse from a dictionary.

class databricks.sdk.service.catalog.DeleteCredentialResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.DeleteMonitorResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteMonitorResponse from a dictionary.

class databricks.sdk.service.catalog.DeletePolicyResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeletePolicyResponse from a dictionary.

class databricks.sdk.service.catalog.DeleteRequestExternalLineage(source: 'ExternalLineageObject', target: 'ExternalLineageObject', id: 'Optional[str]' = None)

source: ExternalLineageObject

Source object of the external lineage relationship.

target: ExternalLineageObject

Target object of the external lineage relationship.

id: str | None = None

Unique identifier of the external lineage relationship.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteRequestExternalLineage from a dictionary.

class databricks.sdk.service.catalog.DeleteResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteResponse from a dictionary.

class databricks.sdk.service.catalog.DeleteTableConstraintResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeleteTableConstraintResponse from a dictionary.

class databricks.sdk.service.catalog.DeltaRuntimePropertiesKvPairs(delta_runtime_properties: Dict[str, str])

Properties pertaining to the current state of the delta table as given by the commit server. This does not contain delta.* (input) properties in __TableInfo.properties__.

delta_runtime_properties: Dict[str, str]

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DeltaRuntimePropertiesKvPairs from a dictionary.

class databricks.sdk.service.catalog.DeltaSharingScopeEnum

INTERNAL = "INTERNAL"

INTERNAL_AND_EXTERNAL = "INTERNAL_AND_EXTERNAL"

class databricks.sdk.service.catalog.Dependency(connection: ConnectionDependency | None = None, credential: CredentialDependency | None = None, function: FunctionDependency | None = None, table: TableDependency | None = None)

A dependency of a SQL object. One of the following fields must be defined: __table__, __function__, __connection__, __credential__, __volume__, or __secret__.

connection: ConnectionDependency | None = None

credential: CredentialDependency | None = None

function: FunctionDependency | None = None

table: TableDependency | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Dependency from a dictionary.

class databricks.sdk.service.catalog.DependencyList(dependencies: List[Dependency] | None = None)

A list of dependencies.

dependencies: List[Dependency] | None = None

Array of dependencies.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DependencyList from a dictionary.

class databricks.sdk.service.catalog.DestinationType

EMAIL = "EMAIL"

GENERIC_WEBHOOK = "GENERIC_WEBHOOK"

MICROSOFT_TEAMS = "MICROSOFT_TEAMS"

SLACK = "SLACK"

URL = "URL"

class databricks.sdk.service.catalog.DisableResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the DisableResponse from a dictionary.

class databricks.sdk.service.catalog.EffectivePermissionsList(next_page_token: 'Optional[str]' = None, privilege_assignments: 'Optional[List[EffectivePrivilegeAssignment]]' = 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[EffectivePrivilegeAssignment] | None = None

The privileges conveyed to each principal (either directly or via inheritance)

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EffectivePermissionsList from a dictionary.

class databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlag(value: 'EnablePredictiveOptimization', inherited_from_name: 'Optional[str]' = None, inherited_from_type: 'Optional[EffectivePredictiveOptimizationFlagInheritedFromType]' = None)

value: EnablePredictiveOptimization

Whether predictive optimization should be enabled for this object and objects under it.

inherited_from_name: str | None = None

The name of the object from which the flag was inherited. If there was no inheritance, this field is left blank.

inherited_from_type: EffectivePredictiveOptimizationFlagInheritedFromType | None = None

The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EffectivePredictiveOptimizationFlag from a dictionary.

class databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlagInheritedFromType

CATALOG = "CATALOG"

SCHEMA = "SCHEMA"

class databricks.sdk.service.catalog.EffectivePrivilege(inherited_from_name: 'Optional[str]' = None, inherited_from_type: 'Optional[SecurableType]' = None, privilege: 'Optional[Privilege]' = None)

inherited_from_name: str | None = None

The full name of the object that conveys this privilege via inheritance. This field is omitted when privilege is not inherited (it’s assigned to the securable itself).

inherited_from_type: SecurableType | None = None

The type of the object that conveys this privilege via inheritance. This field is omitted when privilege is not inherited (it’s assigned to the securable itself).

privilege: Privilege | None = None

The privilege assigned to the principal.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EffectivePrivilege from a dictionary.

class databricks.sdk.service.catalog.EffectivePrivilegeAssignment(principal: 'Optional[str]' = None, privileges: 'Optional[List[EffectivePrivilege]]' = None)

principal: str | None = None

The principal (user email address or group name).

privileges: List[EffectivePrivilege] | None = None

The privileges conveyed to the principal (either directly or via inheritance).

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EffectivePrivilegeAssignment from a dictionary.

class databricks.sdk.service.catalog.EnablePredictiveOptimization

DISABLE = "DISABLE"

ENABLE = "ENABLE"

INHERIT = "INHERIT"

class databricks.sdk.service.catalog.EnableResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EnableResponse from a dictionary.

class databricks.sdk.service.catalog.EncryptionDetails(sse_encryption_details: SseEncryptionDetails | None = None)

Encryption options that apply to clients connecting to cloud storage.

sse_encryption_details: SseEncryptionDetails | None = None

Server-Side Encryption properties for clients communicating with AWS s3.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EncryptionDetails from a dictionary.

class databricks.sdk.service.catalog.EncryptionSettings(azure_encryption_settings: AzureEncryptionSettings | None = None, azure_key_vault_key_id: str | None = None, customer_managed_key_id: str | None = None)

Encryption Settings are used to carry metadata for securable encryption at rest. Currently used for catalogs, we can use the information supplied here to interact with a CMK.

azure_encryption_settings: AzureEncryptionSettings | None = None

optional Azure settings - only required if an Azure CMK is used.

azure_key_vault_key_id: str | None = None

the AKV URL in Azure, null otherwise.

customer_managed_key_id: str | None = None

the CMK uuid in AWS and GCP, null otherwise.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EncryptionSettings from a dictionary.

class databricks.sdk.service.catalog.EntityTagAssignment(entity_name: str, tag_key: str, entity_type: str, source_type: TagAssignmentSourceType | None = None, tag_value: str | None = None, update_time: Timestamp | None = None, updated_by: str | None = None)

Represents a tag assignment to an entity

entity_name: str

The fully qualified name of the entity to which the tag is assigned

tag_key: str

The key of the tag

entity_type: str

The type of the entity to which the tag is assigned.

source_type: TagAssignmentSourceType | None = None

The source type of the tag assignment, e.g., user-assigned or system-assigned

tag_value: str | None = None

The value of the tag

update_time: Timestamp | None = None

The timestamp when the tag assignment was last updated

updated_by: str | None = None

The user or principal who updated the tag assignment

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the EntityTagAssignment from a dictionary.

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

name: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageExternalMetadata from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageExternalMetadataInfo(entity_type: str | None = None, event_time: str | None = None, name: str | None = None, system_type: SystemType | None = None)

Represents the external metadata object in the lineage event.

entity_type: str | None = None

Type of entity represented by the external metadata object.

event_time: str | None = None

Timestamp of the lineage event.

name: str | None = None

Name of the external metadata object.

system_type: SystemType | None = None

Type of external system.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageExternalMetadataInfo from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageFileInfo(event_time: str | None = None, path: str | None = None, securable_name: str | None = None, securable_type: str | None = None, storage_location: str | None = None)

Represents the path information in the lineage event.

event_time: str | None = None

Timestamp of the lineage event.

path: str | None = None

URL of the path.

securable_name: str | None = None

The full name of the securable on the path.

securable_type: str | None = None

The securable type of the securable on the path.

storage_location: str | None = None

The storage location associated with securable on the path.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageFileInfo from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageInfo(external_lineage_info: ExternalLineageRelationshipInfo | None = None, external_metadata_info: ExternalLineageExternalMetadataInfo | None = None, file_info: ExternalLineageFileInfo | None = None, model_info: ExternalLineageModelVersionInfo | None = None, table_info: ExternalLineageTableInfo | None = None)

Lineage response containing lineage information of a data asset.

external_lineage_info: ExternalLineageRelationshipInfo | None = None

Information about the edge metadata of the external lineage relationship.

external_metadata_info: ExternalLineageExternalMetadataInfo | None = None

Information about external metadata involved in the lineage relationship.

file_info: ExternalLineageFileInfo | None = None

Information about the file involved in the lineage relationship.

model_info: ExternalLineageModelVersionInfo | None = None

Information about the model version involved in the lineage relationship.

table_info: ExternalLineageTableInfo | None = None

Information about the table involved in the lineage relationship.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageInfo from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageModelVersion(name: 'Optional[str]' = None, version: 'Optional[str]' = None)

name: str | None = None

version: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageModelVersion from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageModelVersionInfo(event_time: str | None = None, model_name: str | None = None, version: int | None = None)

Represents the model version information in the lineage event.

event_time: str | None = None

Timestamp of the lineage event.

model_name: str | None = None

Name of the model.

version: int | None = None

Version number of the model.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageModelVersionInfo from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageObject(external_metadata: 'Optional[ExternalLineageExternalMetadata]' = None, model_version: 'Optional[ExternalLineageModelVersion]' = None, path: 'Optional[ExternalLineagePath]' = None, table: 'Optional[ExternalLineageTable]' = None)

external_metadata: ExternalLineageExternalMetadata | None = None

model_version: ExternalLineageModelVersion | None = None

path: ExternalLineagePath | None = None

table: ExternalLineageTable | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageObject from a dictionary.

class databricks.sdk.service.catalog.ExternalLineagePath(url: 'Optional[str]' = None)

url: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineagePath from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageRelationship(source: 'ExternalLineageObject', target: 'ExternalLineageObject', columns: 'Optional[List[ColumnRelationship]]' = None, id: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None)

source: ExternalLineageObject

Source object of the external lineage relationship.

target: ExternalLineageObject

Target object of the external lineage relationship.

columns: List[ColumnRelationship] | None = None

List of column relationships between source and target objects.

id: str | None = None

Unique identifier of the external lineage relationship.

properties: Dict[str, str] | None = None

Key-value properties associated with the external lineage relationship.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageRelationship from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageRelationshipInfo(source: 'ExternalLineageObject', target: 'ExternalLineageObject', columns: 'Optional[List[ColumnRelationship]]' = None, id: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None)

source: ExternalLineageObject

Source object of the external lineage relationship.

target: ExternalLineageObject

Target object of the external lineage relationship.

columns: List[ColumnRelationship] | None = None

List of column relationships between source and target objects.

id: str | None = None

Unique identifier of the external lineage relationship.

properties: Dict[str, str] | None = None

Key-value properties associated with the external lineage relationship.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageRelationshipInfo from a dictionary.

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

name: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageTable from a dictionary.

class databricks.sdk.service.catalog.ExternalLineageTableInfo(catalog_name: str | None = None, event_time: str | None = None, name: str | None = None, schema_name: str | None = None)

Represents the table information in the lineage event.

catalog_name: str | None = None

Name of Catalog.

event_time: str | None = None

Timestamp of the lineage event.

name: str | None = None

Name of Table.

schema_name: str | None = None

Name of Schema.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLineageTableInfo from a dictionary.

class databricks.sdk.service.catalog.ExternalLocationInfo(browse_only: 'Optional[bool]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, credential_id: 'Optional[str]' = None, credential_name: 'Optional[str]' = None, effective_enable_file_events: 'Optional[bool]' = None, effective_file_event_queue: 'Optional[FileEventQueue]' = None, enable_file_events: 'Optional[bool]' = None, encryption_details: 'Optional[EncryptionDetails]' = None, fallback: 'Optional[bool]' = None, file_event_queue: 'Optional[FileEventQueue]' = None, isolation_mode: 'Optional[IsolationMode]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, read_only: 'Optional[bool]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, url: 'Optional[str]' = None)

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

comment: str | None = None

User-provided free-form text description.

created_at: int | None = None

Time at which this external location was created, in epoch milliseconds.

created_by: str | None = None

Username of external location creator.

credential_id: str | None = None

Unique ID of the location’s storage credential.

credential_name: str | None = None

Name of the storage credential used with this location.

effective_enable_file_events: bool | None = None

The effective value of enable_file_events after applying server-side defaults.

effective_file_event_queue: FileEventQueue | None = None

The effective file event queue configuration after applying server-side defaults. Always populated when a queue is provisioned, regardless of whether the user explicitly set enable_file_events. Use this field instead of file_event_queue for reading the actual queue state.

enable_file_events: bool | None = None

Whether to enable file events on this external location. Default to true. Set to false to disable file events. The actual applied value may differ due to server-side defaults; check effective_enable_file_events for the effective state.

encryption_details: EncryptionDetails | None = None

fallback: bool | None = None

Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.

file_event_queue: FileEventQueue | None = None

File event queue settings. If enable_file_events is not false, must be defined and have exactly one of the documented properties.

isolation_mode: IsolationMode | None = None

metastore_id: str | None = None

Unique identifier of metastore hosting the external location.

name: str | None = None

Name of the external location.

owner: str | None = None

The owner of the external location.

read_only: bool | None = None

Indicates whether the external location is read-only.

updated_at: int | None = None

Time at which external location this was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the external location.

url: str | None = None

Path URL of the external location.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalLocationInfo from a dictionary.

class databricks.sdk.service.catalog.ExternalMetadata(name: 'str', system_type: 'SystemType', entity_type: 'str', columns: 'Optional[List[str]]' = None, create_time: 'Optional[str]' = None, created_by: 'Optional[str]' = None, description: 'Optional[str]' = None, id: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, owner: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None, update_time: 'Optional[str]' = None, updated_by: 'Optional[str]' = None, url: 'Optional[str]' = None)

name: str

Name of the external metadata object.

system_type: SystemType

Type of external system.

entity_type: str

Type of entity within the external system.

columns: List[str] | None = None

List of columns associated with the external metadata object.

create_time: str | None = None

Time at which this external metadata object was created.

created_by: str | None = None

Username of external metadata object creator.

description: str | None = None

User-provided free-form text description.

id: str | None = None

Unique identifier of the external metadata object.

metastore_id: str | None = None

Unique identifier of parent metastore.

owner: str | None = None

Owner of the external metadata object.

properties: Dict[str, str] | None = None

A map of key-value properties attached to the external metadata object.

update_time: str | None = None

Time at which this external metadata object was last modified.

updated_by: str | None = None

Username of user who last modified external metadata object.

url: str | None = None

URL associated with the external metadata object.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ExternalMetadata from a dictionary.

class databricks.sdk.service.catalog.FailedStatus(last_processed_commit_version: int | None = None, timestamp: str | None = None)

Detailed status of an online table. Shown if the online table is in the OFFLINE_FAILED or the ONLINE_PIPELINE_FAILED state.

last_processed_commit_version: int | None = None

The last source table Delta version that was synced to the online table. Note that this Delta version may only be partially synced to the online table. Only populated if the table is still online and available for serving.

timestamp: str | None = None

The timestamp of the last time any data was synchronized from the source table to the online table. Only populated if the table is still online and available for serving.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the FailedStatus from a dictionary.

class databricks.sdk.service.catalog.FileEventQueue(managed_aqs: 'Optional[AzureQueueStorage]' = None, managed_pubsub: 'Optional[GcpPubsub]' = None, managed_sqs: 'Optional[AwsSqsQueue]' = None, provided_aqs: 'Optional[AzureQueueStorage]' = None, provided_pubsub: 'Optional[GcpPubsub]' = None, provided_sqs: 'Optional[AwsSqsQueue]' = None)

managed_aqs: AzureQueueStorage | None = None

managed_pubsub: GcpPubsub | None = None

managed_sqs: AwsSqsQueue | None = None

provided_aqs: AzureQueueStorage | None = None

provided_pubsub: GcpPubsub | None = None

provided_sqs: AwsSqsQueue | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the FileEventQueue from a dictionary.

class databricks.sdk.service.catalog.ForeignKeyConstraint(name: 'str', child_columns: 'List[str]', parent_table: 'str', parent_columns: 'List[str]', rely: 'Optional[bool]' = None)

name: str

The name of the constraint.

child_columns: List[str]

Column names for this constraint.

parent_table: str

The full name of the parent constraint.

parent_columns: List[str]

Column names for this constraint.

rely: bool | None = None

True if the constraint is RELY, false or unset if NORELY.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ForeignKeyConstraint from a dictionary.

class databricks.sdk.service.catalog.FunctionArgument(alias: 'Optional[str]' = None, constant: 'Optional[str]' = None)

alias: str | None = None

The alias of a matched column.

constant: str | None = None

A constant literal.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the FunctionArgument from a dictionary.

class databricks.sdk.service.catalog.FunctionDependency(function_full_name: str)

A function that is dependent on a SQL object.

function_full_name: str

Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the FunctionDependency from a dictionary.

class databricks.sdk.service.catalog.FunctionInfo(browse_only: 'Optional[bool]' = None, catalog_name: 'Optional[str]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, data_type: 'Optional[ColumnTypeName]' = None, external_language: 'Optional[str]' = None, external_name: 'Optional[str]' = None, full_data_type: 'Optional[str]' = None, full_name: 'Optional[str]' = None, function_id: 'Optional[str]' = None, input_params: 'Optional[FunctionParameterInfos]' = None, is_deterministic: 'Optional[bool]' = None, is_null_call: 'Optional[bool]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, parameter_style: 'Optional[FunctionInfoParameterStyle]' = None, properties: 'Optional[str]' = None, return_params: 'Optional[FunctionParameterInfos]' = None, routine_body: 'Optional[FunctionInfoRoutineBody]' = None, routine_definition: 'Optional[str]' = None, routine_dependencies: 'Optional[DependencyList]' = None, schema_name: 'Optional[str]' = None, security_type: 'Optional[FunctionInfoSecurityType]' = None, specific_name: 'Optional[str]' = None, sql_data_access: 'Optional[FunctionInfoSqlDataAccess]' = None, sql_path: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None

Name of parent Catalog.

comment: str | None = None

User-provided free-form text description.

created_at: int | None = None

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

created_by: str | None = None

Username of function creator.

data_type: ColumnTypeName | None = None

Scalar function return data type.

external_language: str | None = None

External function language.

external_name: str | None = None

External function name.

full_data_type: str | None = None

Pretty printed function data type.

full_name: str | None = None

Full name of Function, in form of catalog_name.**schema_name**.**function_name**

function_id: str | None = None

Id of Function, relative to parent schema.

input_params: FunctionParameterInfos | None = None

Function input parameters.

is_deterministic: bool | None = None

Whether the function is deterministic.

is_null_call: bool | None = None

Function null call.

metastore_id: str | None = None

Unique identifier of parent metastore.

name: str | None = None

Name of function, relative to parent schema.

owner: str | None = None

Username of current owner of the function.

parameter_style: FunctionInfoParameterStyle | None = None

Function parameter style. S is the value for SQL.

properties: str | None = None

JSON-serialized key-value pair map, encoded (escaped) as a string.

return_params: FunctionParameterInfos | None = None

Table function return parameters.

routine_body: FunctionInfoRoutineBody | None = None

Function language. When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.

routine_definition: str | None = None

Function body.

routine_dependencies: DependencyList | None = None

function dependencies.

schema_name: str | None = None

Name of parent Schema relative to its parent Catalog.

security_type: FunctionInfoSecurityType | None = None

Function security type.

specific_name: str | None = None

Specific name of the function; Reserved for future use.

sql_data_access: FunctionInfoSqlDataAccess | None = None

Function SQL data access.

sql_path: str | None = None

List of schemes whose objects can be referenced without qualification.

updated_at: int | None = None

Time at which this function was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the function.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the FunctionInfo from a dictionary.

class databricks.sdk.service.catalog.FunctionInfoParameterStyle

S = "S"

class databricks.sdk.service.catalog.FunctionInfoRoutineBody

EXTERNAL = "EXTERNAL"

SQL = "SQL"

class databricks.sdk.service.catalog.FunctionInfoSecurityType

DEFINER = "DEFINER"

class databricks.sdk.service.catalog.FunctionInfoSqlDataAccess

CONTAINS_SQL = "CONTAINS_SQL"

NO_SQL = "NO_SQL"

READS_SQL_DATA = "READS_SQL_DATA"

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

name: str

Name of Parameter.

type_text: str

Full data type spec, SQL/catalogString text.

type_name: ColumnTypeName

Name of type (INT, STRUCT, MAP, etc.)

position: int

Ordinal position of column (starting at position 0).

comment: str | None = None

User-provided free-form text description.

parameter_default: str | None = None

Default value of the parameter.

parameter_mode: FunctionParameterMode | None = None

Function parameter mode.

parameter_type: FunctionParameterType | None = None

Function parameter type.

type_interval_type: str | None = None

Format of IntervalType.

type_json: str | None = None

Full data type spec, JSON-serialized.

type_precision: int | None = None

Digits of precision; required on Create for DecimalTypes.

type_scale: int | None = None

Digits to right of decimal; Required on Create for DecimalTypes.

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.catalog.FunctionParameterInfos(parameters: 'Optional[List[FunctionParameterInfo]]' = None)

parameters: List[FunctionParameterInfo] | None = None

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.catalog.FunctionParameterMode

IN = "IN"

class databricks.sdk.service.catalog.FunctionParameterType

COLUMN = "COLUMN"

PARAM = "PARAM"

class databricks.sdk.service.catalog.GcpOauthToken(oauth_token: str | None = None)

GCP temporary credentials for API authentication. Read more at https://developers.google.com/identity/protocols/oauth2/service-account

oauth_token: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpOauthToken from a dictionary.

class databricks.sdk.service.catalog.GcpPubsub(managed_resource_id: 'Optional[str]' = None, subscription_name: 'Optional[str]' = None)

managed_resource_id: str | None = None

Unique identifier included in the name of file events managed cloud resources.

subscription_name: str | None = None

The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}. Only required for provided_pubsub.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GcpPubsub from a dictionary.

class databricks.sdk.service.catalog.GenerateTemporaryPathCredentialResponse(aws_temp_credentials: 'Optional[AwsCredentials]' = None, azure_aad: 'Optional[AzureActiveDirectoryToken]' = None, azure_user_delegation_sas: 'Optional[AzureUserDelegationSas]' = None, expiration_time: 'Optional[int]' = None, gcp_oauth_token: 'Optional[GcpOauthToken]' = None, r2_temp_credentials: 'Optional[R2Credentials]' = None, url: 'Optional[str]' = None)

aws_temp_credentials: AwsCredentials | None = None

azure_aad: AzureActiveDirectoryToken | None = None

azure_user_delegation_sas: AzureUserDelegationSas | None = None

expiration_time: int | None = None

Server time when the credential will expire, in epoch milliseconds. The API client is advised to cache the credential given this expiration time.

gcp_oauth_token: GcpOauthToken | None = None

r2_temp_credentials: R2Credentials | None = None

url: str | None = None

The URL of the storage path accessible by the temporary credential.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GenerateTemporaryPathCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.GenerateTemporaryServiceCredentialAzureOptions(resources: List[str] | None = None)

The Azure cloud options to customize the requested temporary credential

resources: List[str] | None = None

The resources to which the temporary Azure credential should apply. These resources are the scopes that are passed to the token provider (see https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python)

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GenerateTemporaryServiceCredentialAzureOptions from a dictionary.

class databricks.sdk.service.catalog.GenerateTemporaryServiceCredentialGcpOptions(scopes: List[str] | None = None)

The GCP cloud options to customize the requested temporary credential

scopes: List[str] | None = None

The scopes to which the temporary GCP credential should apply. These resources are the scopes that are passed to the token provider (see https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.credentials.Credentials)

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GenerateTemporaryServiceCredentialGcpOptions from a dictionary.

class databricks.sdk.service.catalog.GenerateTemporaryTableCredentialResponse(aws_temp_credentials: 'Optional[AwsCredentials]' = None, azure_aad: 'Optional[AzureActiveDirectoryToken]' = None, azure_user_delegation_sas: 'Optional[AzureUserDelegationSas]' = None, expiration_time: 'Optional[int]' = None, gcp_oauth_token: 'Optional[GcpOauthToken]' = None, r2_temp_credentials: 'Optional[R2Credentials]' = None, url: 'Optional[str]' = None)

aws_temp_credentials: AwsCredentials | None = None

azure_aad: AzureActiveDirectoryToken | None = None

azure_user_delegation_sas: AzureUserDelegationSas | None = None

expiration_time: int | None = None

Server time when the credential will expire, in epoch milliseconds. The API client is advised to cache the credential given this expiration time.

gcp_oauth_token: GcpOauthToken | None = None

r2_temp_credentials: R2Credentials | None = None

url: str | None = None

The URL of the storage path accessible by the temporary credential.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GenerateTemporaryTableCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.GenerateTemporaryVolumeCredentialResponse(aws_temp_credentials: 'Optional[AwsCredentials]' = None, azure_aad: 'Optional[AzureActiveDirectoryToken]' = None, azure_user_delegation_sas: 'Optional[AzureUserDelegationSas]' = None, expiration_time: 'Optional[int]' = None, gcp_oauth_token: 'Optional[GcpOauthToken]' = None, r2_temp_credentials: 'Optional[R2Credentials]' = None, url: 'Optional[str]' = None)

aws_temp_credentials: AwsCredentials | None = None

azure_aad: AzureActiveDirectoryToken | None = None

azure_user_delegation_sas: AzureUserDelegationSas | None = None

expiration_time: int | None = None

Server time when the credential will expire, in epoch milliseconds. The API client is advised to cache the credential given this expiration time.

gcp_oauth_token: GcpOauthToken | None = None

r2_temp_credentials: R2Credentials | None = None

url: str | None = None

The URL of the storage path accessible by the temporary credential.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GenerateTemporaryVolumeCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.GetCatalogWorkspaceBindingsResponse(workspaces: 'Optional[List[int]]' = None)

workspaces: List[int] | None = None

A list of workspace IDs

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetCatalogWorkspaceBindingsResponse from a dictionary.

class databricks.sdk.service.catalog.GetMetastoreSummaryResponse(cloud: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, default_data_access_config_id: 'Optional[str]' = None, delta_sharing_organization_name: 'Optional[str]' = None, delta_sharing_recipient_token_lifetime_in_seconds: 'Optional[int]' = None, delta_sharing_scope: 'Optional[DeltaSharingScopeEnum]' = None, external_access_enabled: 'Optional[bool]' = None, global_metastore_id: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, privilege_model_version: 'Optional[str]' = None, region: 'Optional[str]' = None, storage_root: 'Optional[str]' = None, storage_root_credential_id: 'Optional[str]' = None, storage_root_credential_name: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

cloud: str | None = None

Cloud vendor of the metastore home shard (e.g., aws, azure, gcp).

created_at: int | None = None

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

created_by: str | None = None

Username of metastore creator.

default_data_access_config_id: str | None = None

Unique identifier of the metastore’s (Default) Data Access Configuration.

delta_sharing_organization_name: str | None = None

The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.

delta_sharing_recipient_token_lifetime_in_seconds: int | None = None

The lifetime of delta sharing recipient token in seconds.

delta_sharing_scope: DeltaSharingScopeEnum | None = None

The scope of Delta Sharing enabled for the metastore.

external_access_enabled: bool | None = None

Whether to allow non-DBR clients to directly access entities under the metastore.

global_metastore_id: str | None = None

Globally unique metastore ID across clouds and regions, of the form cloud:region:metastore_id.

metastore_id: str | None = None

Unique identifier of metastore.

name: str | None = None

The user-specified name of the metastore.

owner: str | None = None

The owner of the metastore.

privilege_model_version: str | None = None

Privilege model version of the metastore, of the form major.minor (e.g., 1.0).

region: str | None = None

Cloud region which the metastore serves (e.g., us-west-2, westus).

storage_root: str | None = None

The storage root URL for metastore

storage_root_credential_id: str | None = None

UUID of storage credential to access the metastore storage_root.

storage_root_credential_name: str | None = None

Name of the storage credential to access the metastore storage_root.

updated_at: int | None = None

Time at which the metastore was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the metastore.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetMetastoreSummaryResponse from a dictionary.

class databricks.sdk.service.catalog.GetPermissionsResponse(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 GetPermissionsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

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

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

Deserializes the GetPermissionsResponse from a dictionary.

class databricks.sdk.service.catalog.GetQuotaResponse(quota_info: 'Optional[QuotaInfo]' = None)

quota_info: QuotaInfo | None = None

The returned QuotaInfo.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetQuotaResponse from a dictionary.

class databricks.sdk.service.catalog.GetWorkspaceBindingsResponse(bindings: 'Optional[List[WorkspaceBinding]]' = None, next_page_token: 'Optional[str]' = None)

bindings: List[WorkspaceBinding] | None = None

List of workspace bindings

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the GetWorkspaceBindingsResponse from a dictionary.

class databricks.sdk.service.catalog.IsolationMode

ISOLATION_MODE_ISOLATED = "ISOLATION_MODE_ISOLATED"

ISOLATION_MODE_OPEN = "ISOLATION_MODE_OPEN"

class databricks.sdk.service.catalog.LineageDirection

DOWNSTREAM = "DOWNSTREAM"

UPSTREAM = "UPSTREAM"

class databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse(workspace_ids: List[int] | None = None)

The metastore assignments were successfully returned.

workspace_ids: List[int] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListAccountMetastoreAssignmentsResponse from a dictionary.

class databricks.sdk.service.catalog.ListAccountStorageCredentialsResponse(storage_credentials: List[StorageCredentialInfo] | None = None)

The metastore storage credentials were successfully returned.

storage_credentials: List[StorageCredentialInfo] | None = None

An array of metastore storage credentials.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListAccountStorageCredentialsResponse from a dictionary.

class databricks.sdk.service.catalog.ListCatalogsResponse(catalogs: 'Optional[List[CatalogInfo]]' = None, next_page_token: 'Optional[str]' = None)

catalogs: List[CatalogInfo] | None = None

An array of catalog information objects.

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListCatalogsResponse from a dictionary.

class databricks.sdk.service.catalog.ListConnectionsResponse(connections: 'Optional[List[ConnectionInfo]]' = None, next_page_token: 'Optional[str]' = None)

connections: List[ConnectionInfo] | None = None

An array of connection information objects.

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListConnectionsResponse from a dictionary.

class databricks.sdk.service.catalog.ListCredentialsResponse(credentials: 'Optional[List[CredentialInfo]]' = None, next_page_token: 'Optional[str]' = None)

credentials: List[CredentialInfo] | None = 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).

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListCredentialsResponse from a dictionary.

class databricks.sdk.service.catalog.ListEntityTagAssignmentsResponse(next_page_token: 'Optional[str]' = None, tag_assignments: 'Optional[List[EntityTagAssignment]]' = None)

next_page_token: str | None = None

Optional. Pagination token for retrieving the next page of results

tag_assignments: List[EntityTagAssignment] | None = None

The list of tag assignments

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListEntityTagAssignmentsResponse from a dictionary.

class databricks.sdk.service.catalog.ListExternalLineageRelationshipsResponse(external_lineage_relationships: 'Optional[List[ExternalLineageInfo]]' = None, next_page_token: 'Optional[str]' = None)

external_lineage_relationships: List[ExternalLineageInfo] | None = None

next_page_token: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListExternalLineageRelationshipsResponse from a dictionary.

class databricks.sdk.service.catalog.ListExternalLocationsResponse(external_locations: 'Optional[List[ExternalLocationInfo]]' = None, next_page_token: 'Optional[str]' = None)

external_locations: List[ExternalLocationInfo] | None = None

An array of external locations.

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListExternalLocationsResponse from a dictionary.

class databricks.sdk.service.catalog.ListExternalMetadataResponse(external_metadata: 'Optional[List[ExternalMetadata]]' = None, next_page_token: 'Optional[str]' = None)

external_metadata: List[ExternalMetadata] | None = None

next_page_token: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListExternalMetadataResponse from a dictionary.

class databricks.sdk.service.catalog.ListFunctionsResponse(functions: 'Optional[List[FunctionInfo]]' = None, next_page_token: 'Optional[str]' = None)

functions: List[FunctionInfo] | None = None

An array of function information objects.

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListFunctionsResponse from a dictionary.

class databricks.sdk.service.catalog.ListMetastoresResponse(metastores: 'Optional[List[MetastoreInfo]]' = None, next_page_token: 'Optional[str]' = None)

metastores: List[MetastoreInfo] | None = None

An array of metastore information objects.

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

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListMetastoresResponse from a dictionary.

class databricks.sdk.service.catalog.ListModelVersionsResponse(model_versions: 'Optional[List[ModelVersionInfo]]' = None, next_page_token: 'Optional[str]' = None)

model_versions: List[ModelVersionInfo] | None = 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).

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListModelVersionsResponse from a dictionary.

class databricks.sdk.service.catalog.ListPoliciesResponse(next_page_token: 'Optional[str]' = None, policies: 'Optional[List[PolicyInfo]]' = None)

next_page_token: str | None = None

Optional opaque token for continuing pagination. page_token should be set to this value for the next request to retrieve the next page of results.

policies: List[PolicyInfo] | None = None

The list of retrieved policies.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListPoliciesResponse from a dictionary.

class databricks.sdk.service.catalog.ListQuotasResponse(next_page_token: 'Optional[str]' = None, quotas: 'Optional[List[QuotaInfo]]' = 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.

quotas: List[QuotaInfo] | None = None

An array of returned QuotaInfos.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListQuotasResponse from a dictionary.

class databricks.sdk.service.catalog.ListRegisteredModelsResponse(next_page_token: 'Optional[str]' = None, registered_models: 'Optional[List[RegisteredModelInfo]]' = None)

next_page_token: str | None = None

Opaque token for pagination. Omitted if there are no more results. page_token should be set to this value for fetching the next page.

registered_models: List[RegisteredModelInfo] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListRegisteredModelsResponse from a dictionary.

class databricks.sdk.service.catalog.ListSchemasResponse(next_page_token: 'Optional[str]' = None, schemas: 'Optional[List[SchemaInfo]]' = 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).

schemas: List[SchemaInfo] | None = None

An array of schema information objects.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListSchemasResponse from a dictionary.

class databricks.sdk.service.catalog.ListSecretsResponse(next_page_token: str | None = None, secrets: List[Secret] | None = None)

Response message for ListSecrets.

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.

secrets: List[Secret] | None = None

An array of secret objects.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListSecretsResponse from a dictionary.

class databricks.sdk.service.catalog.ListStorageCredentialsResponse(next_page_token: 'Optional[str]' = None, storage_credentials: 'Optional[List[StorageCredentialInfo]]' = 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).

storage_credentials: List[StorageCredentialInfo] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListStorageCredentialsResponse from a dictionary.

class databricks.sdk.service.catalog.ListSystemSchemasResponse(next_page_token: 'Optional[str]' = None, schemas: 'Optional[List[SystemSchemaInfo]]' = 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).

schemas: List[SystemSchemaInfo] | None = None

An array of system schema information objects.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListSystemSchemasResponse from a dictionary.

class databricks.sdk.service.catalog.ListTableSummariesResponse(next_page_token: 'Optional[str]' = None, tables: 'Optional[List[TableSummary]]' = 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).

tables: List[TableSummary] | None = None

List of table summaries.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListTableSummariesResponse from a dictionary.

class databricks.sdk.service.catalog.ListTablesResponse(next_page_token: 'Optional[str]' = None, tables: 'Optional[List[TableInfo]]' = 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).

tables: List[TableInfo] | None = None

An array of table information objects.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListTablesResponse from a dictionary.

class databricks.sdk.service.catalog.ListVolumesResponseContent(next_page_token: 'Optional[str]' = None, volumes: 'Optional[List[VolumeInfo]]' = 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 to retrieve the next page of results.

volumes: List[VolumeInfo] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListVolumesResponseContent from a dictionary.

class databricks.sdk.service.catalog.MatchColumn(alias: 'Optional[str]' = None, condition: 'Optional[str]' = None)

alias: str | None = None

Optional alias of the matched column.

condition: str | None = None

The condition expression used to match a table column.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MatchColumn from a dictionary.

class databricks.sdk.service.catalog.MatchType

The artifact pattern matching type

PREFIX_MATCH = "PREFIX_MATCH"

class databricks.sdk.service.catalog.MetastoreAssignment(workspace_id: 'int', metastore_id: 'str', default_catalog_name: 'Optional[str]' = None)

workspace_id: int

The unique ID of the Databricks workspace.

metastore_id: str

The unique ID of the metastore.

default_catalog_name: str | None = None

The name of the default catalog in the metastore. This field is deprecated. Please use “Default Namespace API” to configure the default catalog for a Databricks workspace.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.MetastoreInfo(cloud: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, default_data_access_config_id: 'Optional[str]' = None, delta_sharing_organization_name: 'Optional[str]' = None, delta_sharing_recipient_token_lifetime_in_seconds: 'Optional[int]' = None, delta_sharing_scope: 'Optional[DeltaSharingScopeEnum]' = None, external_access_enabled: 'Optional[bool]' = None, global_metastore_id: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, privilege_model_version: 'Optional[str]' = None, region: 'Optional[str]' = None, storage_root: 'Optional[str]' = None, storage_root_credential_id: 'Optional[str]' = None, storage_root_credential_name: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

cloud: str | None = None

Cloud vendor of the metastore home shard (e.g., aws, azure, gcp).

created_at: int | None = None

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

created_by: str | None = None

Username of metastore creator.

default_data_access_config_id: str | None = None

Unique identifier of the metastore’s (Default) Data Access Configuration.

delta_sharing_organization_name: str | None = None

The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.

delta_sharing_recipient_token_lifetime_in_seconds: int | None = None

The lifetime of delta sharing recipient token in seconds.

delta_sharing_scope: DeltaSharingScopeEnum | None = None

The scope of Delta Sharing enabled for the metastore.

external_access_enabled: bool | None = None

Whether to allow non-DBR clients to directly access entities under the metastore.

global_metastore_id: str | None = None

Globally unique metastore ID across clouds and regions, of the form cloud:region:metastore_id.

metastore_id: str | None = None

Unique identifier of metastore.

name: str | None = None

The user-specified name of the metastore.

owner: str | None = None

The owner of the metastore.

privilege_model_version: str | None = None

Privilege model version of the metastore, of the form major.minor (e.g., 1.0).

region: str | None = None

Cloud region which the metastore serves (e.g., us-west-2, westus).

storage_root: str | None = None

The storage root URL for metastore

storage_root_credential_id: str | None = None

UUID of storage credential to access the metastore storage_root.

storage_root_credential_name: str | None = None

Name of the storage credential to access the metastore storage_root.

updated_at: int | None = None

Time at which the metastore was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the metastore.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MetastoreInfo from a dictionary.

class databricks.sdk.service.catalog.ModelVersionInfo(aliases: 'Optional[List[RegisteredModelAlias]]' = None, catalog_name: 'Optional[str]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, id: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, model_name: 'Optional[str]' = None, model_version_dependencies: 'Optional[DependencyList]' = None, run_id: 'Optional[str]' = None, run_workspace_id: 'Optional[int]' = None, schema_name: 'Optional[str]' = None, source: 'Optional[str]' = None, status: 'Optional[ModelVersionInfoStatus]' = None, storage_location: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, version: 'Optional[int]' = None)

aliases: List[RegisteredModelAlias] | None = None

List of aliases associated with the model version

catalog_name: str | None = None

The name of the catalog containing the model version

comment: str | None = None

The comment attached to the model version

created_at: int | None = None

created_by: str | None = None

The identifier of the user who created the model version

id: str | None = None

The unique identifier of the model version

metastore_id: str | None = None

The unique identifier of the metastore containing the model version

model_name: str | None = None

The name of the parent registered model of the model version, relative to parent schema

model_version_dependencies: DependencyList | None = None

Model version dependencies, for feature-store packaged models

run_id: str | None = None

MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server

run_workspace_id: int | None = None

ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable

schema_name: str | None = None

The name of the schema containing the model version, relative to parent catalog

source: str | None = None

URI indicating the location of the source artifacts (files) for the model version

status: ModelVersionInfoStatus | None = None

Current status of the model version. Newly created model versions start in PENDING_REGISTRATION status, then move to READY status once the model version files are uploaded and the model version is finalized. Only model versions in READY status can be loaded for inference or served.

storage_location: str | None = None

The storage location on the cloud under which model version data files are stored

updated_at: int | None = None

updated_by: str | None = None

The identifier of the user who updated the model version last time

version: int | None = None

Integer model version number, used to reference the model version in API requests.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ModelVersionInfo from a dictionary.

class databricks.sdk.service.catalog.ModelVersionInfoStatus

FAILED_REGISTRATION = "FAILED_REGISTRATION"

MODEL_VERSION_STATUS_UNKNOWN = "MODEL_VERSION_STATUS_UNKNOWN"

PENDING_REGISTRATION = "PENDING_REGISTRATION"

READY = "READY"

class databricks.sdk.service.catalog.MonitorCronSchedule(quartz_cron_expression: 'str', timezone_id: 'str', pause_status: 'Optional[MonitorCronSchedulePauseStatus]' = None)

quartz_cron_expression: str

The expression that determines when to run the monitor. See [examples].

[examples]: https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html

timezone_id: str

The timezone id (e.g., PST) in which to evaluate the quartz expression.

pause_status: MonitorCronSchedulePauseStatus | None = None

Read only field that indicates whether a schedule is paused or not.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorCronSchedule from a dictionary.

class databricks.sdk.service.catalog.MonitorCronSchedulePauseStatus

Source link: https://src.dev.databricks.com/databricks/universe/-/blob/elastic-spark-common/api/messages/schedule.proto Monitoring workflow schedule pause status.

PAUSED = "PAUSED"

UNPAUSED = "UNPAUSED"

UNSPECIFIED = "UNSPECIFIED"

class databricks.sdk.service.catalog.MonitorDataClassificationConfig(enabled: bool | None = None)

Data classification related configuration.

enabled: bool | None = None

Whether to enable data classification.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorDataClassificationConfig from a dictionary.

class databricks.sdk.service.catalog.MonitorDestination(email_addresses: 'Optional[List[str]]' = None)

email_addresses: List[str] | None = None

The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorDestination from a dictionary.

class databricks.sdk.service.catalog.MonitorInferenceLog(problem_type: 'MonitorInferenceLogProblemType', timestamp_col: 'str', granularities: 'List[str]', prediction_col: 'str', model_id_col: 'str', label_col: 'Optional[str]' = None, prediction_proba_col: 'Optional[str]' = None)

problem_type: MonitorInferenceLogProblemType

Problem type the model aims to solve.

timestamp_col: str

Column for the timestamp.

granularities: List[str]

List of granularities to use when aggregating data into time windows based on their timestamp.

prediction_col: str

Column for the prediction.

model_id_col: str

Column for the model identifier.

label_col: str | None = None

Column for the label.

prediction_proba_col: str | None = None

Column for prediction probabilities

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorInferenceLog from a dictionary.

class databricks.sdk.service.catalog.MonitorInferenceLogProblemType

PROBLEM_TYPE_CLASSIFICATION = "PROBLEM_TYPE_CLASSIFICATION"

PROBLEM_TYPE_REGRESSION = "PROBLEM_TYPE_REGRESSION"

class databricks.sdk.service.catalog.MonitorInfo(output_schema_name: 'str', table_name: 'str', status: 'MonitorInfoStatus', profile_metrics_table_name: 'str', drift_metrics_table_name: 'str', monitor_version: 'int', assets_dir: 'Optional[str]' = None, baseline_table_name: 'Optional[str]' = None, custom_metrics: 'Optional[List[MonitorMetric]]' = None, dashboard_id: 'Optional[str]' = None, data_classification_config: 'Optional[MonitorDataClassificationConfig]' = None, inference_log: 'Optional[MonitorInferenceLog]' = None, latest_monitor_failure_msg: 'Optional[str]' = None, notifications: 'Optional[MonitorNotifications]' = None, schedule: 'Optional[MonitorCronSchedule]' = None, slicing_exprs: 'Optional[List[str]]' = None, snapshot: 'Optional[MonitorSnapshot]' = None, time_series: 'Optional[MonitorTimeSeries]' = None)

output_schema_name: str

[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}

table_name: str

[Create:ERR Update:IGN] UC table to monitor. Format: catalog.schema.table_name

status: MonitorInfoStatus

[Create:ERR Update:IGN] The monitor status.

profile_metrics_table_name: str

[Create:ERR Update:IGN] Table that stores profile metrics data. Format: catalog.schema.table_name.

drift_metrics_table_name: str

[Create:ERR Update:IGN] Table that stores drift metrics data. Format: catalog.schema.table_name.

monitor_version: int

[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a numeric fashion (1,2,3…). The field has flexibility to take on negative values, which can indicate corrupted monitor_version numbers.

assets_dir: str | None = None

[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring assets. Normally prepopulated to a default user location via UI and Python APIs.

baseline_table_name: str | None = None

[Create:OPT Update:OPT] Baseline table name. Baseline data is used to compute drift from the data in the monitored table_name. The baseline table and the monitored table shall have the same schema.

custom_metrics: List[MonitorMetric] | None = None

[Create:OPT Update:OPT] Custom metrics.

dashboard_id: str | None = None

[Create:ERR Update:OPT] Id of dashboard that visualizes the computed metrics. This can be empty if the monitor is in PENDING state.

data_classification_config: MonitorDataClassificationConfig | None = None

[Create:OPT Update:OPT] Data classification related config.

inference_log: MonitorInferenceLog | None = None

latest_monitor_failure_msg: str | None = None

[Create:ERR Update:IGN] The latest error message for a monitor failure.

notifications: MonitorNotifications | None = None

[Create:OPT Update:OPT] Field for specifying notification settings.

schedule: MonitorCronSchedule | None = None

[Create:OPT Update:OPT] The monitor schedule.

slicing_exprs: List[str] | None = None

[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For example slicing_exprs=[“col_1”, “col_2 > 10”] will generate the following slices: two slices for col_2 > 10 (True and False), and one slice per unique value in col1. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.

snapshot: MonitorSnapshot | None = None

Configuration for monitoring snapshot tables.

time_series: MonitorTimeSeries | None = None

Configuration for monitoring time series tables.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorInfo from a dictionary.

class databricks.sdk.service.catalog.MonitorInfoStatus

MONITOR_STATUS_ACTIVE = "MONITOR_STATUS_ACTIVE"

MONITOR_STATUS_DELETE_PENDING = "MONITOR_STATUS_DELETE_PENDING"

MONITOR_STATUS_ERROR = "MONITOR_STATUS_ERROR"

MONITOR_STATUS_FAILED = "MONITOR_STATUS_FAILED"

MONITOR_STATUS_PENDING = "MONITOR_STATUS_PENDING"

class databricks.sdk.service.catalog.MonitorMetric(name: str, definition: str, input_columns: List[str], output_data_type: str, type: MonitorMetricType)

Custom metric definition.

name: str

Name of the metric in the output tables.

definition: str

Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition].

[create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition

input_columns: List[str]

A list of column names in the input table the metric should be computed for. Can use ":table" to indicate that the metric needs information from multiple columns.

output_data_type: str

The output type of the custom metric.

type: MonitorMetricType

Can only be one of "CUSTOM_METRIC_TYPE_AGGREGATE", "CUSTOM_METRIC_TYPE_DERIVED", or "CUSTOM_METRIC_TYPE_DRIFT". The "CUSTOM_METRIC_TYPE_AGGREGATE" and "CUSTOM_METRIC_TYPE_DERIVED" metrics are computed on a single table, whereas the "CUSTOM_METRIC_TYPE_DRIFT" compare metrics across baseline and input table, or across the two consecutive time windows. - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorMetric from a dictionary.

class databricks.sdk.service.catalog.MonitorMetricType

Can only be one of "CUSTOM_METRIC_TYPE_AGGREGATE", "CUSTOM_METRIC_TYPE_DERIVED", or "CUSTOM_METRIC_TYPE_DRIFT". The "CUSTOM_METRIC_TYPE_AGGREGATE" and "CUSTOM_METRIC_TYPE_DERIVED" metrics are computed on a single table, whereas the "CUSTOM_METRIC_TYPE_DRIFT" compare metrics across baseline and input table, or across the two consecutive time windows. - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics

CUSTOM_METRIC_TYPE_AGGREGATE = "CUSTOM_METRIC_TYPE_AGGREGATE"

CUSTOM_METRIC_TYPE_DERIVED = "CUSTOM_METRIC_TYPE_DERIVED"

CUSTOM_METRIC_TYPE_DRIFT = "CUSTOM_METRIC_TYPE_DRIFT"

class databricks.sdk.service.catalog.MonitorNotifications(on_failure: 'Optional[MonitorDestination]' = None, on_new_classification_tag_detected: 'Optional[MonitorDestination]' = None)

on_failure: MonitorDestination | None = None

Destinations to send notifications on failure/timeout.

on_new_classification_tag_detected: MonitorDestination | None = None

Destinations to send notifications on new classification tag detected.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorNotifications from a dictionary.

class databricks.sdk.service.catalog.MonitorRefreshInfo(refresh_id: 'int', state: 'MonitorRefreshInfoState', start_time_ms: 'int', end_time_ms: 'Optional[int]' = None, message: 'Optional[str]' = None, trigger: 'Optional[MonitorRefreshInfoTrigger]' = None)

refresh_id: int

Unique id of the refresh operation.

state: MonitorRefreshInfoState

The current state of the refresh.

start_time_ms: int

Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).

end_time_ms: int | None = None

Time at which refresh operation completed (milliseconds since 1/1/1970 UTC).

message: str | None = None

An optional message to give insight into the current state of the job (e.g. FAILURE messages).

trigger: MonitorRefreshInfoTrigger | None = None

The method by which the refresh was triggered.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorRefreshInfo from a dictionary.

class databricks.sdk.service.catalog.MonitorRefreshInfoState

The current state of the refresh.

CANCELED = "CANCELED"

FAILED = "FAILED"

PENDING = "PENDING"

RUNNING = "RUNNING"

SUCCESS = "SUCCESS"

UNKNOWN = "UNKNOWN"

class databricks.sdk.service.catalog.MonitorRefreshInfoTrigger

MANUAL = "MANUAL"

SCHEDULE = "SCHEDULE"

UNKNOWN_TRIGGER = "UNKNOWN_TRIGGER"

class databricks.sdk.service.catalog.MonitorRefreshListResponse(refreshes: 'Optional[List[MonitorRefreshInfo]]' = None)

refreshes: List[MonitorRefreshInfo] | None = None

List of refreshes.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorRefreshListResponse from a dictionary.

class databricks.sdk.service.catalog.MonitorSnapshot

Snapshot analysis configuration

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorSnapshot from a dictionary.

class databricks.sdk.service.catalog.MonitorTimeSeries(timestamp_col: str, granularities: List[str])

Time series analysis configuration.

timestamp_col: str

Column for the timestamp.

granularities: List[str]

Granularities for aggregating data into time windows based on their timestamp. Currently the following static granularities are supported: {"5 minutes", "30 minutes", "1 hour", "1 day", "<n> week(s)", "1 month", "1 year"}.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the MonitorTimeSeries from a dictionary.

class databricks.sdk.service.catalog.NamedTableConstraint(name: 'str')

name: str

The name of the constraint.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the NamedTableConstraint from a dictionary.

class databricks.sdk.service.catalog.NotificationDestination(destination_id: 'Optional[str]' = None, destination_type: 'Optional[DestinationType]' = None, special_destination: 'Optional[SpecialDestination]' = None)

destination_id: str | None = None

The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations, or the unique Databricks notification destination ID for all other external destinations.

destination_type: DestinationType | None = None

The type of the destination.

special_destination: SpecialDestination | None = None

This field is used to denote whether the destination is the email of the owner of the securable object. The special destination cannot be assigned to a securable and only represents the default destination of the securable. The securable types that support default special destinations are: “catalog”, “external_location”, “connection”, “credential”, and “metastore”. The destination_type of a special_destination is always EMAIL.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the NotificationDestination from a dictionary.

class databricks.sdk.service.catalog.OnlineTable(name: str | None = None, spec: OnlineTableSpec | None = None, status: OnlineTableStatus | None = None, table_serving_url: str | None = None, unity_catalog_provisioning_state: ProvisioningInfoState | None = None)

Online Table information.

name: str | None = None

Full three-part (catalog, schema, table) name of the table.

spec: OnlineTableSpec | None = None

Specification of the online table.

status: OnlineTableStatus | None = None

Online Table data synchronization status

table_serving_url: str | None = None

Data serving REST API URL for this table

unity_catalog_provisioning_state: ProvisioningInfoState | None = None

The provisioning state of the online table entity in Unity Catalog. This is distinct from the state of the data synchronization pipeline (i.e. the table may be in “ACTIVE” but the pipeline may be in “PROVISIONING” as it runs asynchronously).

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OnlineTable from a dictionary.

class databricks.sdk.service.catalog.OnlineTableSpec(perform_full_copy: bool | None = None, pipeline_id: str | None = None, primary_key_columns: List[str] | None = None, run_continuously: OnlineTableSpecContinuousSchedulingPolicy | None = None, run_triggered: OnlineTableSpecTriggeredSchedulingPolicy | None = None, source_table_full_name: str | None = None, timeseries_key: str | None = None)

Specification of an online table.

perform_full_copy: bool | None = None

Whether to create a full-copy pipeline – a pipeline that stops after creates a full copy of the source table upon initialization and does not process any change data feeds (CDFs) afterwards. The pipeline can still be manually triggered afterwards, but it always perform a full copy of the source table and there are no incremental updates. This mode is useful for syncing views or tables without CDFs to online tables. Note that the full-copy pipeline only supports “triggered” scheduling policy.

pipeline_id: str | None = None

ID of the associated pipeline. Generated by the server - cannot be set by the caller.

primary_key_columns: List[str] | None = None

Primary Key columns to be used for data insert/update in the destination.

run_continuously: OnlineTableSpecContinuousSchedulingPolicy | None = None

Pipeline runs continuously after generating the initial data.

run_triggered: OnlineTableSpecTriggeredSchedulingPolicy | None = None

Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers)

source_table_full_name: str | None = None

Three-part (catalog, schema, table) name of the source Delta table.

timeseries_key: str | None = None

Time series key to deduplicate (tie-break) rows with the same primary key.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OnlineTableSpec from a dictionary.

class databricks.sdk.service.catalog.OnlineTableSpecContinuousSchedulingPolicy

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OnlineTableSpecContinuousSchedulingPolicy from a dictionary.

class databricks.sdk.service.catalog.OnlineTableSpecTriggeredSchedulingPolicy

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OnlineTableSpecTriggeredSchedulingPolicy from a dictionary.

class databricks.sdk.service.catalog.OnlineTableState

The state of an online table.

OFFLINE = "OFFLINE"

OFFLINE_FAILED = "OFFLINE_FAILED"

ONLINE = "ONLINE"

ONLINE_CONTINUOUS_UPDATE = "ONLINE_CONTINUOUS_UPDATE"

ONLINE_NO_PENDING_UPDATE = "ONLINE_NO_PENDING_UPDATE"

ONLINE_PIPELINE_FAILED = "ONLINE_PIPELINE_FAILED"

ONLINE_TRIGGERED_UPDATE = "ONLINE_TRIGGERED_UPDATE"

ONLINE_UPDATING_PIPELINE_RESOURCES = "ONLINE_UPDATING_PIPELINE_RESOURCES"

PROVISIONING = "PROVISIONING"

PROVISIONING_INITIAL_SNAPSHOT = "PROVISIONING_INITIAL_SNAPSHOT"

PROVISIONING_PIPELINE_RESOURCES = "PROVISIONING_PIPELINE_RESOURCES"

class databricks.sdk.service.catalog.OnlineTableStatus(continuous_update_status: ContinuousUpdateStatus | None = None, detailed_state: OnlineTableState | None = None, failed_status: FailedStatus | None = None, message: str | None = None, provisioning_status: ProvisioningStatus | None = None, triggered_update_status: TriggeredUpdateStatus | None = None)

Status of an online table.

continuous_update_status: ContinuousUpdateStatus | None = None

detailed_state: OnlineTableState | None = None

The state of the online table.

failed_status: FailedStatus | None = None

message: str | None = None

A text description of the current state of the online table.

provisioning_status: ProvisioningStatus | None = None

triggered_update_status: TriggeredUpdateStatus | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OnlineTableStatus from a dictionary.

class databricks.sdk.service.catalog.OptionSpec(allowed_values: List[str] | None = None, default_value: str | None = None, description: str | None = None, hint: str | None = None, is_copiable: bool | None = None, is_creatable: bool | None = None, is_hidden: bool | None = None, is_loggable: bool | None = None, is_required: bool | None = None, is_secret: bool | None = None, is_updatable: bool | None = None, name: str | None = None, oauth_stage: OptionSpecOauthStage | None = None, type: OptionSpecOptionType | None = None)

Spec of an allowed option on a securable kind and its attributes. This is mostly used by UI to provide user friendly hints and descriptions in order to facilitate the securable creation process.

allowed_values: List[str] | None = None

For drop down / radio button selections, UI will want to know the possible input values, it can also be used by other option types to limit input selections.

default_value: str | None = None

The default value of the option, for example, value ‘443’ for ‘port’ option.

description: str | None = None

A concise user facing description of what the input value of this option should look like.

hint: str | None = None

The hint is used on the UI to suggest what the input value can possibly be like, for example: example.com for ‘host’ option. Unlike default value, it will not be applied automatically without user input.

is_copiable: bool | None = None

Indicates whether an option should be displayed with copy button on the UI.

is_creatable: bool | None = None

Indicates whether an option can be provided by users in the create/update path of an entity.

is_hidden: bool | None = None

Is the option value not user settable and is thus not shown on the UI.

is_loggable: bool | None = None

Specifies whether this option is safe to log, i.e. no sensitive information.

is_required: bool | None = None

Is the option required.

is_secret: bool | None = None

Is the option value considered secret and thus redacted on the UI.

is_updatable: bool | None = None

Is the option updatable by users.

name: str | None = None

The unique name of the option.

oauth_stage: OptionSpecOauthStage | None = None

Specifies when the option value is displayed on the UI within the OAuth flow.

type: OptionSpecOptionType | None = None

The type of the option.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OptionSpec from a dictionary.

class databricks.sdk.service.catalog.OptionSpecOauthStage

During the OAuth flow, specifies which stage the option should be displayed in the UI. OAUTH_STAGE_UNSPECIFIED is the default value for options unrelated to the OAuth flow. BEFORE_AUTHORIZATION_CODE corresponds to options necessary to initiate the OAuth process. BEFORE_ACCESS_TOKEN corresponds to options that are necessary to create a foreign connection, but that should be displayed after the authorization code has already been received.

BEFORE_ACCESS_TOKEN = "BEFORE_ACCESS_TOKEN"

BEFORE_AUTHORIZATION_CODE = "BEFORE_AUTHORIZATION_CODE"

class databricks.sdk.service.catalog.OptionSpecOptionType

Type of the option, we purposely follow JavaScript types so that the UI can map the options to JS types. https://www.w3schools.com/js/js_datatypes.asp Enum is a special case that it’s just string with selections.

OPTION_BIGINT = "OPTION_BIGINT"

OPTION_BOOLEAN = "OPTION_BOOLEAN"

OPTION_ENUM = "OPTION_ENUM"

OPTION_MULTILINE_STRING = "OPTION_MULTILINE_STRING"

OPTION_NUMBER = "OPTION_NUMBER"

OPTION_SERVICE_CREDENTIAL = "OPTION_SERVICE_CREDENTIAL"

OPTION_STRING = "OPTION_STRING"

class databricks.sdk.service.catalog.PathOperation

PATH_CREATE_TABLE = "PATH_CREATE_TABLE"

PATH_READ = "PATH_READ"

PATH_READ_WRITE = "PATH_READ_WRITE"

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

add: List[Privilege] | 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[Privilege] | 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.catalog.PipelineProgress(estimated_completion_time_seconds: float | None = None, latest_version_currently_processing: int | None = None, sync_progress_completion: float | None = None, synced_row_count: int | None = None, total_row_count: int | None = None)

Progress information of the Online Table data synchronization pipeline.

estimated_completion_time_seconds: float | None = None

The estimated time remaining to complete this update in seconds.

latest_version_currently_processing: int | None = None

The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet.

sync_progress_completion: float | None = None

The completion ratio of this update. This is a number between 0 and 1.

synced_row_count: int | None = None

The number of rows that have been synced in this update.

total_row_count: int | None = None

The total number of rows that need to be synced in this update. This number may be an estimate.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the PipelineProgress from a dictionary.

class databricks.sdk.service.catalog.PolicyFunctionArgument(column: str | None = None, constant: str | None = None)

A positional argument passed to a row filter or column mask function. Distinguishes between column references and literals.

column: str | None = None

A column reference.

constant: str | None = None

A constant literal.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the PolicyFunctionArgument from a dictionary.

class databricks.sdk.service.catalog.PolicyInfo(to_principals: 'List[str]', for_securable_type: 'SecurableType', policy_type: 'PolicyType', column_mask: 'Optional[ColumnMaskOptions]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, except_principals: 'Optional[List[str]]' = None, id: 'Optional[str]' = None, match_columns: 'Optional[List[MatchColumn]]' = None, name: 'Optional[str]' = None, on_securable_fullname: 'Optional[str]' = None, on_securable_type: 'Optional[SecurableType]' = None, row_filter: 'Optional[RowFilterOptions]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, when_condition: 'Optional[str]' = None)

to_principals: List[str]

List of user or group names that the policy applies to. Required on create and optional on update.

for_securable_type: SecurableType

Type of securables that the policy should take effect on. Only TABLE is supported at this moment. Required on create and optional on update.

policy_type: PolicyType

Type of the policy. Required on create.

column_mask: ColumnMaskOptions | None = None

Options for column mask policies. Valid only if policy_type is POLICY_TYPE_COLUMN_MASK. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole.

comment: str | None = None

Optional description of the policy.

created_at: int | None = None

Time at which the policy was created, in epoch milliseconds. Output only.

created_by: str | None = None

Username of the user who created the policy. Output only.

except_principals: List[str] | None = None

Optional list of user or group names that should be excluded from the policy.

id: str | None = None

Unique identifier of the policy. This field is output only and is generated by the system.

match_columns: List[MatchColumn] | None = None

Optional list of condition expressions used to match table columns. Only valid when for_securable_type is TABLE. When specified, the policy only applies to tables whose columns satisfy all match conditions.

name: str | None = None

Name of the policy. Required on create and optional on update. To rename the policy, set name to a different value on update.

on_securable_fullname: str | None = None

Full name of the securable on which the policy is defined. Required on create.

on_securable_type: SecurableType | None = None

Type of the securable on which the policy is defined. Only CATALOG, SCHEMA and TABLE are supported at this moment. Required on create.

row_filter: RowFilterOptions | None = None

Options for row filter policies. Valid only if policy_type is POLICY_TYPE_ROW_FILTER. Required on create and optional on update. When specified on update, the new options will replace the existing options as a whole.

updated_at: int | None = None

Time at which the policy was last modified, in epoch milliseconds. Output only.

updated_by: str | None = None

Username of the user who last modified the policy. Output only.

when_condition: str | None = None

Optional condition when the policy should take effect.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the PolicyInfo from a dictionary.

class databricks.sdk.service.catalog.PolicyType

POLICY_TYPE_COLUMN_MASK = "POLICY_TYPE_COLUMN_MASK"

POLICY_TYPE_ROW_FILTER = "POLICY_TYPE_ROW_FILTER"

class databricks.sdk.service.catalog.PrimaryKeyConstraint(name: 'str', child_columns: 'List[str]', rely: 'Optional[bool]' = None, timeseries_columns: 'Optional[List[str]]' = None)

name: str

The name of the constraint.

child_columns: List[str]

Column names for this constraint.

rely: bool | None = None

True if the constraint is RELY, false or unset if NORELY.

timeseries_columns: List[str] | None = None

Column names that represent a timeseries.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the PrimaryKeyConstraint from a dictionary.

class databricks.sdk.service.catalog.Principal(id: 'Optional[str]' = None, principal_type: 'Optional[PrincipalType]' = None)

id: str | None = None

Databricks user, group or service principal ID.

principal_type: PrincipalType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Principal from a dictionary.

class databricks.sdk.service.catalog.PrincipalType

GROUP_PRINCIPAL = "GROUP_PRINCIPAL"

SERVICE_PRINCIPAL = "SERVICE_PRINCIPAL"

USER_PRINCIPAL = "USER_PRINCIPAL"

class databricks.sdk.service.catalog.Privilege

ACCESS = "ACCESS"

ALL_PRIVILEGES = "ALL_PRIVILEGES"

APPLY_TAG = "APPLY_TAG"

BROWSE = "BROWSE"

CREATE = "CREATE"

CREATE_CATALOG = "CREATE_CATALOG"

CREATE_CLEAN_ROOM = "CREATE_CLEAN_ROOM"

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"

EXECUTE_CLEAN_ROOM_TASK = "EXECUTE_CLEAN_ROOM_TASK"

EXTERNAL_USE_SCHEMA = "EXTERNAL_USE_SCHEMA"

MANAGE = "MANAGE"

MANAGE_ALLOWLIST = "MANAGE_ALLOWLIST"

MODIFY = "MODIFY"

MODIFY_CLEAN_ROOM = "MODIFY_CLEAN_ROOM"

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.catalog.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.catalog.ProvisioningInfo(state: ProvisioningInfoState | None = None)

Status of an asynchronously provisioned resource.

state: ProvisioningInfoState | None = None

The provisioning state of the resource.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ProvisioningInfo from a dictionary.

class databricks.sdk.service.catalog.ProvisioningInfoState

ACTIVE = "ACTIVE"

DEGRADED = "DEGRADED"

DELETING = "DELETING"

FAILED = "FAILED"

PROVISIONING = "PROVISIONING"

UPDATING = "UPDATING"

class databricks.sdk.service.catalog.ProvisioningStatus(initial_pipeline_sync_progress: PipelineProgress | None = None)

Detailed status of an online table. Shown if the online table is in the PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.

initial_pipeline_sync_progress: PipelineProgress | None = None

Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ProvisioningStatus from a dictionary.

class databricks.sdk.service.catalog.QuotaInfo(last_refreshed_at: 'Optional[int]' = None, parent_full_name: 'Optional[str]' = None, parent_securable_type: 'Optional[SecurableType]' = None, quota_count: 'Optional[int]' = None, quota_limit: 'Optional[int]' = None, quota_name: 'Optional[str]' = None)

last_refreshed_at: int | None = None

The timestamp that indicates when the quota count was last updated.

parent_full_name: str | None = None

Name of the parent resource. Returns metastore ID if the parent is a metastore.

parent_securable_type: SecurableType | None = None

The quota parent securable type.

quota_count: int | None = None

The current usage of the resource quota.

quota_limit: int | None = None

The current limit of the resource quota.

quota_name: str | None = None

The name of the quota.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the QuotaInfo from a dictionary.

class databricks.sdk.service.catalog.R2Credentials(access_key_id: str | None = None, secret_access_key: str | None = None, session_token: str | None = None)

R2 temporary credentials for API authentication. Read more at https://developers.cloudflare.com/r2/api/s3/tokens/.

access_key_id: str | None = None

The access key ID that identifies the temporary credentials.

secret_access_key: str | None = None

The secret access key associated with the access key.

session_token: str | None = None

The generated JWT that users must pass to use the temporary credentials.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the R2Credentials from a dictionary.

class databricks.sdk.service.catalog.RegenerateDashboardResponse(dashboard_id: 'Optional[str]' = None, parent_folder: 'Optional[str]' = None)

dashboard_id: str | None = None

parent_folder: str | None = None

Parent folder is equivalent to {assets_dir}/{tableName}

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RegenerateDashboardResponse from a dictionary.

class databricks.sdk.service.catalog.RegisteredModelAlias(alias_name: 'Optional[str]' = None, catalog_name: 'Optional[str]' = None, id: 'Optional[str]' = None, model_name: 'Optional[str]' = None, schema_name: 'Optional[str]' = None, version_num: 'Optional[int]' = None)

alias_name: str | None = None

Name of the alias, e.g. ‘champion’ or ‘latest_stable’

catalog_name: str | None = None

The name of the catalog containing the model version

id: str | None = None

The unique identifier of the alias

model_name: str | None = None

The name of the parent registered model of the model version, relative to parent schema

schema_name: str | None = None

The name of the schema containing the model version, relative to parent catalog

version_num: int | None = None

Integer version number of the model version to which this alias points.

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.catalog.RegisteredModelInfo(aliases: 'Optional[List[RegisteredModelAlias]]' = None, browse_only: 'Optional[bool]' = None, catalog_name: 'Optional[str]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, full_name: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, schema_name: 'Optional[str]' = None, storage_location: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None)

aliases: List[RegisteredModelAlias] | None = None

List of aliases associated with the registered model

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None

The name of the catalog where the schema and the registered model reside

comment: str | None = None

The comment attached to the registered model

created_at: int | None = None

Creation timestamp of the registered model in milliseconds since the Unix epoch

created_by: str | None = None

The identifier of the user who created the registered model

full_name: str | None = None

The three-level (fully qualified) name of the registered model

metastore_id: str | None = None

The unique identifier of the metastore

name: str | None = None

The name of the registered model

owner: str | None = None

The identifier of the user who owns the registered model

schema_name: str | None = None

The name of the schema where the registered model resides

storage_location: str | None = None

The storage location on the cloud under which model version data files are stored

updated_at: int | None = None

Last-update timestamp of the registered model in milliseconds since the Unix epoch

updated_by: str | None = None

The identifier of the user who updated the registered model last time

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RegisteredModelInfo from a dictionary.

class databricks.sdk.service.catalog.RowFilterOptions(function_name: 'str', using: 'Optional[List[FunctionArgument]]' = None)

function_name: str

The fully qualified name of the row filter function. The function is called on each row of the target table. It should return a boolean value indicating whether the row should be visible to the user. Required on create and update.

using: List[FunctionArgument] | None = None

Optional list of column aliases or constant literals to be passed as arguments to the row filter function. The type of each column should match the positional argument of the row filter function.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RowFilterOptions from a dictionary.

class databricks.sdk.service.catalog.SchemaInfo(browse_only: bool | None = None, catalog_name: str | None = None, catalog_type: CatalogType | None = None, comment: str | None = None, created_at: int | None = None, created_by: str | None = None, effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None, enable_predictive_optimization: EnablePredictiveOptimization | None = None, full_name: str | None = None, metastore_id: str | None = None, name: str | None = None, owner: str | None = None, properties: Dict[str, str] | None = None, schema_id: str | None = None, storage_location: str | None = None, storage_root: str | None = None, updated_at: int | None = None, updated_by: str | None = None)

Next ID: 45

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None

Name of parent catalog.

catalog_type: CatalogType | None = None

The type of the parent catalog.

comment: str | None = None

User-provided free-form text description.

created_at: int | None = None

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

created_by: str | None = None

Username of schema creator.

effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None

enable_predictive_optimization: EnablePredictiveOptimization | None = None

Whether predictive optimization should be enabled for this object and objects under it.

full_name: str | None = None

Full name of schema, in form of __catalog_name__.__schema_name__.

metastore_id: str | None = None

Unique identifier of parent metastore.

name: str | None = None

Name of schema, relative to parent catalog.

owner: str | None = None

Username of current owner of schema.

properties: Dict[str, str] | None = None

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

schema_id: str | None = None

The unique identifier of the schema.

storage_location: str | None = None

Storage location for managed tables within schema.

storage_root: str | None = None

Storage root URL for managed tables within schema.

updated_at: int | None = None

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

updated_by: str | None = None

Username of user who last modified schema.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SchemaInfo from a dictionary.

class databricks.sdk.service.catalog.Secret(name: str, catalog_name: str, schema_name: str, value: str, browse_only: bool | None = None, comment: str | None = None, create_time: Timestamp | None = None, created_by: str | None = None, effective_owner: str | None = None, effective_value: str | None = None, expire_time: Timestamp | None = None, external_secret_id: str | None = None, full_name: str | None = None, metastore_id: str | None = None, owner: str | None = None, update_time: Timestamp | None = None, updated_by: str | None = None)

A secret stored in Unity Catalog. Secrets are three-level namespace objects (catalog.schema.secret) that securely store sensitive credential data such as passwords, tokens, and keys.

name: str

The name of the secret, relative to its parent schema.

catalog_name: str

The name of the catalog where the schema and the secret reside.

schema_name: str

The name of the schema where the secret resides.

value: str

The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data.

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

comment: str | None = None

User-provided free-form text description of the secret.

create_time: Timestamp | None = None

The time at which this secret was created.

created_by: str | None = None

The principal that created the secret.

effective_owner: str | None = None

The effective owner of the secret, which may differ from the directly-set owner due to inheritance.

effective_value: str | None = None

The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB.

expire_time: Timestamp | None = None

User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret’s lifecycle.

external_secret_id: str | None = None

full_name: str | None = None

The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name.

metastore_id: str | None = None

Unique identifier of the metastore hosting the secret.

owner: str | None = None

The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal.

update_time: Timestamp | None = None

The time at which this secret was last updated.

updated_by: str | None = None

The principal that last updated the secret.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Secret from a dictionary.

class databricks.sdk.service.catalog.Securable(full_name: str | None = None, provider_share: str | None = None, type: SecurableType | None = None)

Generic definition of a securable, which is uniquely defined in a metastore by its type and full name.

full_name: str | None = None

Required. The full name of the catalog/schema/table. Optional if resource_name is present.

provider_share: str | None = None

Optional. The name of the Share object that contains the securable when the securable is getting shared in D2D Delta Sharing.

type: SecurableType | None = None

Required. The type of securable (catalog/schema/table). Optional if resource_name is present.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Securable from a dictionary.

class databricks.sdk.service.catalog.SecurableKind

Latest kind: MEMORY_STORE_STANDARD = 342; Next id: 343. Reserved numbers: 316, 317, 327, 330, 341 (former ENDPOINT_LLM_*, MODEL_SERVICE_STANDARD, MODEL_SERVICE_SYSTEM_DELTASHARING, MCP_SERVICE_STANDARD).

TABLE_DB_STORAGE = "TABLE_DB_STORAGE"

TABLE_DELTA = "TABLE_DELTA"

TABLE_DELTASHARING = "TABLE_DELTASHARING"

TABLE_DELTASHARING_MUTABLE = "TABLE_DELTASHARING_MUTABLE"

TABLE_DELTASHARING_OPEN_DIR_BASED = "TABLE_DELTASHARING_OPEN_DIR_BASED"

TABLE_DELTA_EXTERNAL = "TABLE_DELTA_EXTERNAL"

TABLE_DELTA_ICEBERG_DELTASHARING = "TABLE_DELTA_ICEBERG_DELTASHARING"

TABLE_DELTA_ICEBERG_MANAGED = "TABLE_DELTA_ICEBERG_MANAGED"

TABLE_DELTA_UNIFORM_HUDI_EXTERNAL = "TABLE_DELTA_UNIFORM_HUDI_EXTERNAL"

TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL = "TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL"

TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL_DELTASHARING = "TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL_DELTASHARING"

TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_DELTASHARING = "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_DELTASHARING"

TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_EXTERNAL = "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_EXTERNAL"

TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_MANAGED = "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_MANAGED"

TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_SNOWFLAKE = "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_SNOWFLAKE"

TABLE_EXTERNAL = "TABLE_EXTERNAL"

TABLE_FEATURE_STORE = "TABLE_FEATURE_STORE"

TABLE_FEATURE_STORE_EXTERNAL = "TABLE_FEATURE_STORE_EXTERNAL"

TABLE_FOREIGN_BIGQUERY = "TABLE_FOREIGN_BIGQUERY"

TABLE_FOREIGN_DATABRICKS = "TABLE_FOREIGN_DATABRICKS"

TABLE_FOREIGN_DELTASHARING = "TABLE_FOREIGN_DELTASHARING"

TABLE_FOREIGN_HIVE_METASTORE = "TABLE_FOREIGN_HIVE_METASTORE"

TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL = "TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL"

TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED = "TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED"

TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_EXTERNAL = "TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_EXTERNAL"

TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_MANAGED = "TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_MANAGED"

TABLE_FOREIGN_HIVE_METASTORE_DBFS_VIEW = "TABLE_FOREIGN_HIVE_METASTORE_DBFS_VIEW"

TABLE_FOREIGN_HIVE_METASTORE_EXTERNAL = "TABLE_FOREIGN_HIVE_METASTORE_EXTERNAL"

TABLE_FOREIGN_HIVE_METASTORE_MANAGED = "TABLE_FOREIGN_HIVE_METASTORE_MANAGED"

TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL = "TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL"

TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED = "TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED"

TABLE_FOREIGN_HIVE_METASTORE_VIEW = "TABLE_FOREIGN_HIVE_METASTORE_VIEW"

TABLE_FOREIGN_MONGODB = "TABLE_FOREIGN_MONGODB"

TABLE_FOREIGN_MYSQL = "TABLE_FOREIGN_MYSQL"

TABLE_FOREIGN_NETSUITE = "TABLE_FOREIGN_NETSUITE"

TABLE_FOREIGN_ORACLE = "TABLE_FOREIGN_ORACLE"

TABLE_FOREIGN_POSTGRESQL = "TABLE_FOREIGN_POSTGRESQL"

TABLE_FOREIGN_REDSHIFT = "TABLE_FOREIGN_REDSHIFT"

TABLE_FOREIGN_SALESFORCE = "TABLE_FOREIGN_SALESFORCE"

TABLE_FOREIGN_SALESFORCE_DATA_CLOUD = "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD"

TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING = "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING"

TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING_VIEW = "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING_VIEW"

TABLE_FOREIGN_SNOWFLAKE = "TABLE_FOREIGN_SNOWFLAKE"

TABLE_FOREIGN_SQLDW = "TABLE_FOREIGN_SQLDW"

TABLE_FOREIGN_SQLSERVER = "TABLE_FOREIGN_SQLSERVER"

TABLE_FOREIGN_TERADATA = "TABLE_FOREIGN_TERADATA"

TABLE_FOREIGN_WORKDAY_RAAS = "TABLE_FOREIGN_WORKDAY_RAAS"

TABLE_ICEBERG_UNIFORM_MANAGED = "TABLE_ICEBERG_UNIFORM_MANAGED"

TABLE_INTERNAL = "TABLE_INTERNAL"

TABLE_MANAGED_POSTGRESQL = "TABLE_MANAGED_POSTGRESQL"

TABLE_MATERIALIZED_VIEW = "TABLE_MATERIALIZED_VIEW"

TABLE_MATERIALIZED_VIEW_DELTASHARING = "TABLE_MATERIALIZED_VIEW_DELTASHARING"

TABLE_METRIC_VIEW = "TABLE_METRIC_VIEW"

TABLE_METRIC_VIEW_DELTASHARING = "TABLE_METRIC_VIEW_DELTASHARING"

TABLE_ONLINE_VECTOR_INDEX_DIRECT = "TABLE_ONLINE_VECTOR_INDEX_DIRECT"

TABLE_ONLINE_VECTOR_INDEX_REPLICA = "TABLE_ONLINE_VECTOR_INDEX_REPLICA"

TABLE_ONLINE_VIEW = "TABLE_ONLINE_VIEW"

TABLE_STANDARD = "TABLE_STANDARD"

TABLE_STREAMING_LIVE_TABLE = "TABLE_STREAMING_LIVE_TABLE"

TABLE_STREAMING_LIVE_TABLE_DELTASHARING = "TABLE_STREAMING_LIVE_TABLE_DELTASHARING"

TABLE_SYSTEM = "TABLE_SYSTEM"

TABLE_SYSTEM_DELTASHARING = "TABLE_SYSTEM_DELTASHARING"

TABLE_VIEW = "TABLE_VIEW"

TABLE_VIEW_DELTASHARING = "TABLE_VIEW_DELTASHARING"

class databricks.sdk.service.catalog.SecurableKindManifest(assignable_privileges: List[str] | None = None, capabilities: List[str] | None = None, options: List[OptionSpec] | None = None, securable_kind: SecurableKind | None = None, securable_type: SecurableType | None = None)

Manifest of a specific securable kind.

assignable_privileges: List[str] | None = None

Privileges that can be assigned to the securable.

capabilities: List[str] | None = None

A list of capabilities in the securable kind.

options: List[OptionSpec] | None = None

Detailed specs of allowed options.

securable_kind: SecurableKind | None = None

Securable kind to get manifest of.

securable_type: SecurableType | None = None

Securable Type of the kind.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SecurableKindManifest from a dictionary.

class databricks.sdk.service.catalog.SecurablePermissions(permissions: 'Optional[List[str]]' = None, securable: 'Optional[Securable]' = None)

permissions: List[str] | None = None

List of requested Unity Catalog permissions.

securable: Securable | None = None

The securable for which the access request destinations are being requested.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SecurablePermissions from a dictionary.

class databricks.sdk.service.catalog.SecurableType

The type of Unity Catalog securable.

CATALOG = "CATALOG"

CLEAN_ROOM = "CLEAN_ROOM"

CONNECTION = "CONNECTION"

CREDENTIAL = "CREDENTIAL"

EXTERNAL_LOCATION = "EXTERNAL_LOCATION"

EXTERNAL_METADATA = "EXTERNAL_METADATA"

FUNCTION = "FUNCTION"

METASTORE = "METASTORE"

PIPELINE = "PIPELINE"

PROVIDER = "PROVIDER"

RECIPIENT = "RECIPIENT"

SCHEMA = "SCHEMA"

SHARE = "SHARE"

STAGING_TABLE = "STAGING_TABLE"

STORAGE_CREDENTIAL = "STORAGE_CREDENTIAL"

TABLE = "TABLE"

VOLUME = "VOLUME"

class databricks.sdk.service.catalog.SpecialDestination

SPECIAL_DESTINATION_CATALOG_OWNER = "SPECIAL_DESTINATION_CATALOG_OWNER"

SPECIAL_DESTINATION_CONNECTION_OWNER = "SPECIAL_DESTINATION_CONNECTION_OWNER"

SPECIAL_DESTINATION_CREDENTIAL_OWNER = "SPECIAL_DESTINATION_CREDENTIAL_OWNER"

SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER = "SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER"

SPECIAL_DESTINATION_METASTORE_OWNER = "SPECIAL_DESTINATION_METASTORE_OWNER"

class databricks.sdk.service.catalog.SseEncryptionDetails(algorithm: SseEncryptionDetailsAlgorithm | None = None, aws_kms_key_arn: str | None = None)

Server-Side Encryption properties for clients communicating with AWS s3.

algorithm: SseEncryptionDetailsAlgorithm | None = None

Sets the value of the ‘x-amz-server-side-encryption’ header in S3 request.

aws_kms_key_arn: str | None = None

Optional. The ARN of the SSE-KMS key used with the S3 location, when algorithm = “SSE-KMS”. Sets the value of the ‘x-amz-server-side-encryption-aws-kms-key-id’ header.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SseEncryptionDetails from a dictionary.

class databricks.sdk.service.catalog.SseEncryptionDetailsAlgorithm

AWS_SSE_KMS = "AWS_SSE_KMS"

AWS_SSE_S3 = "AWS_SSE_S3"

class databricks.sdk.service.catalog.StorageCredentialInfo(aws_iam_role: 'Optional[AwsIamRoleResponse]' = None, azure_managed_identity: 'Optional[AzureManagedIdentityResponse]' = None, azure_service_principal: 'Optional[AzureServicePrincipal]' = None, cloudflare_api_token: 'Optional[CloudflareApiToken]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, databricks_gcp_service_account: 'Optional[DatabricksGcpServiceAccountResponse]' = None, full_name: 'Optional[str]' = None, id: 'Optional[str]' = None, isolation_mode: 'Optional[IsolationMode]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, read_only: 'Optional[bool]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, used_for_managed_storage: 'Optional[bool]' = None)

aws_iam_role: AwsIamRoleResponse | None = None

The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentityResponse | None = None

The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None

The Azure service principal configuration.

cloudflare_api_token: CloudflareApiToken | None = None

The Cloudflare API token configuration.

comment: str | None = None

Comment associated with the credential.

created_at: int | None = None

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

created_by: str | None = None

Username of credential creator.

databricks_gcp_service_account: DatabricksGcpServiceAccountResponse | None = None

The Databricks managed GCP service account configuration.

full_name: str | None = None

The full name of the credential.

id: str | None = None

The unique identifier of the credential.

isolation_mode: IsolationMode | None = None

Whether the current securable is accessible from all workspaces or a specific set of workspaces.

metastore_id: str | None = None

Unique identifier of the parent metastore.

name: str | None = None

The credential name. The name must be unique among storage and service credentials within the metastore.

owner: str | None = None

Username of current owner of credential.

read_only: bool | None = None

Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE.

updated_at: int | None = None

Time at which this credential was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the credential.

used_for_managed_storage: bool | None = None

Whether this credential is the current metastore’s root storage credential. Only applicable when purpose is STORAGE.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the StorageCredentialInfo from a dictionary.

class databricks.sdk.service.catalog.SystemSchemaInfo(schema: 'str', state: 'str')

schema: str

Name of the system schema.

state: str

The current state of enablement for the system schema. An empty string means the system schema is available and ready for opt-in. Possible values: AVAILABLE | ENABLE_INITIALIZED | ENABLE_COMPLETED | DISABLE_INITIALIZED | UNAVAILABLE | MANAGED

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SystemSchemaInfo from a dictionary.

class databricks.sdk.service.catalog.SystemType

AMAZON_REDSHIFT = "AMAZON_REDSHIFT"

AZURE_SYNAPSE = "AZURE_SYNAPSE"

CONFLUENT = "CONFLUENT"

DATABRICKS = "DATABRICKS"

GOOGLE_BIGQUERY = "GOOGLE_BIGQUERY"

KAFKA = "KAFKA"

LOOKER = "LOOKER"

MICROSOFT_FABRIC = "MICROSOFT_FABRIC"

MICROSOFT_SQL_SERVER = "MICROSOFT_SQL_SERVER"

MONGODB = "MONGODB"

MYSQL = "MYSQL"

ORACLE = "ORACLE"

OTHER = "OTHER"

POSTGRESQL = "POSTGRESQL"

POWER_BI = "POWER_BI"

SALESFORCE = "SALESFORCE"

SAP = "SAP"

SERVICENOW = "SERVICENOW"

SNOWFLAKE = "SNOWFLAKE"

STREAM_NATIVE = "STREAM_NATIVE"

TABLEAU = "TABLEAU"

TERADATA = "TERADATA"

WORKDAY = "WORKDAY"

class databricks.sdk.service.catalog.TableConstraint(foreign_key_constraint: ForeignKeyConstraint | None = None, named_table_constraint: NamedTableConstraint | None = None, primary_key_constraint: PrimaryKeyConstraint | None = None)

A table constraint, as defined by one of the following fields being set: __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.

foreign_key_constraint: ForeignKeyConstraint | None = None

named_table_constraint: NamedTableConstraint | None = None

primary_key_constraint: PrimaryKeyConstraint | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TableConstraint from a dictionary.

class databricks.sdk.service.catalog.TableDependency(table_full_name: str)

A table that is dependent on a SQL object.

table_full_name: str

Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TableDependency from a dictionary.

class databricks.sdk.service.catalog.TableExistsResponse(table_exists: 'Optional[bool]' = None)

table_exists: bool | None = None

Whether the table exists or not.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TableExistsResponse from a dictionary.

class databricks.sdk.service.catalog.TableInfo(access_point: 'Optional[str]' = None, browse_only: 'Optional[bool]' = None, catalog_name: 'Optional[str]' = None, columns: 'Optional[List[ColumnInfo]]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, data_access_configuration_id: 'Optional[str]' = None, data_source_format: 'Optional[DataSourceFormat]' = None, deleted_at: 'Optional[int]' = None, delta_runtime_properties_kvpairs: 'Optional[DeltaRuntimePropertiesKvPairs]' = None, effective_predictive_optimization_flag: 'Optional[EffectivePredictiveOptimizationFlag]' = None, enable_predictive_optimization: 'Optional[EnablePredictiveOptimization]' = None, encryption_details: 'Optional[EncryptionDetails]' = None, full_name: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, pipeline_id: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None, row_filter: 'Optional[TableRowFilter]' = None, schema_name: 'Optional[str]' = None, securable_kind_manifest: 'Optional[SecurableKindManifest]' = None, sql_path: 'Optional[str]' = None, storage_credential_name: 'Optional[str]' = None, storage_location: 'Optional[str]' = None, table_constraints: 'Optional[List[TableConstraint]]' = None, table_id: 'Optional[str]' = None, table_type: 'Optional[TableType]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, view_definition: 'Optional[str]' = None, view_dependencies: 'Optional[DependencyList]' = None)

access_point: str | None = None

The AWS access point to use when accesing s3 for this external location.

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None

Name of parent catalog.

columns: List[ColumnInfo] | None = None

The array of __ColumnInfo__ definitions of the table’s columns.

comment: str | None = None

User-provided free-form text description.

created_at: int | None = None

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

created_by: str | None = None

Username of table creator.

data_access_configuration_id: str | None = None

Unique ID of the Data Access Configuration to use with the table data.

data_source_format: DataSourceFormat | None = None

deleted_at: int | None = None

Time at which this table was deleted, in epoch milliseconds. Field is omitted if table is not deleted.

delta_runtime_properties_kvpairs: DeltaRuntimePropertiesKvPairs | None = None

Information pertaining to current state of the delta table.

effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None

enable_predictive_optimization: EnablePredictiveOptimization | None = None

encryption_details: EncryptionDetails | None = None

full_name: str | None = None

Full name of table, in form of __catalog_name__.__schema_name__.__table_name__

metastore_id: str | None = None

Unique identifier of parent metastore.

name: str | None = None

Name of table, relative to parent schema.

owner: str | None = None

Username of current owner of table.

pipeline_id: str | None = None

The pipeline ID of the table. Applicable for tables created by pipelines (Materialized View, Streaming Table, etc.).

properties: Dict[str, str] | None = None

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

row_filter: TableRowFilter | None = None

schema_name: str | None = None

Name of parent schema relative to its parent catalog.

securable_kind_manifest: SecurableKindManifest | None = None

SecurableKindManifest of table, including capabilities the table has.

sql_path: str | None = None

List of schemes whose objects can be referenced without qualification.

storage_credential_name: str | None = None

Name of the storage credential, when a storage credential is configured for use with this table.

storage_location: str | None = None

Storage root URL for table (for MANAGED, EXTERNAL tables).

table_constraints: List[TableConstraint] | None = None

List of table constraints. Note: this field is not set in the output of the __listTables__ API.

table_id: str | None = None

The unique identifier of the table.

table_type: TableType | None = None

updated_at: int | None = None

Time at which this table was last modified, in epoch milliseconds.

updated_by: str | None = None

Username of user who last modified the table.

view_definition: str | None = None

View definition SQL (when __table_type__ is VIEW, MATERIALIZED_VIEW, or STREAMING_TABLE)

view_dependencies: DependencyList | None = None

View dependencies (when table_type == VIEW or MATERIALIZED_VIEW, STREAMING_TABLE) - when DependencyList is None, the dependency is not provided; - when DependencyList is an empty list, the dependency is provided but is empty; - when DependencyList is not an empty list, dependencies are provided and recorded. Note: this field is not set in the output of the __listTables__ API.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TableInfo from a dictionary.

class databricks.sdk.service.catalog.TableOperation

READ = "READ"

READ_WRITE = "READ_WRITE"

class databricks.sdk.service.catalog.TableRowFilter(function_name: 'str', input_column_names: 'List[str]', input_arguments: 'Optional[List[PolicyFunctionArgument]]' = None)

function_name: str

The full name of the row filter SQL UDF.

input_column_names: List[str]

The list of table columns to be passed as input to the row filter function. The column types should match the types of the filter function arguments.

input_arguments: List[PolicyFunctionArgument] | None = None

The list of additional table columns or literals to be passed as additional arguments to a row filter function. This is the replacement of the deprecated input_column_names field and carries information about the types (alias or constant) of the arguments to the filter function.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TableRowFilter from a dictionary.

class databricks.sdk.service.catalog.TableSummary(full_name: 'Optional[str]' = None, securable_kind_manifest: 'Optional[SecurableKindManifest]' = None, table_type: 'Optional[TableType]' = None)

full_name: str | None = None

The full name of the table.

securable_kind_manifest: SecurableKindManifest | None = None

SecurableKindManifest of table, including capabilities the table has.

table_type: TableType | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TableSummary from a dictionary.

class databricks.sdk.service.catalog.TableType

EXTERNAL = "EXTERNAL"

EXTERNAL_SHALLOW_CLONE = "EXTERNAL_SHALLOW_CLONE"

FOREIGN = "FOREIGN"

MANAGED = "MANAGED"

MANAGED_SHALLOW_CLONE = "MANAGED_SHALLOW_CLONE"

MATERIALIZED_VIEW = "MATERIALIZED_VIEW"

METRIC_VIEW = "METRIC_VIEW"

STREAMING_TABLE = "STREAMING_TABLE"

VIEW = "VIEW"

class databricks.sdk.service.catalog.TagAssignmentSourceType

Enum representing the source type of a tag assignment

TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION = "TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION"

class databricks.sdk.service.catalog.TagKeyValue(key: 'Optional[str]' = None, value: 'Optional[str]' = None)

key: str | None = None

name of the tag

value: str | None = None

value of the tag associated with the key, could be optional

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TagKeyValue from a dictionary.

class databricks.sdk.service.catalog.TemporaryCredentials(aws_temp_credentials: 'Optional[AwsCredentials]' = None, azure_aad: 'Optional[AzureActiveDirectoryToken]' = None, expiration_time: 'Optional[int]' = None, gcp_oauth_token: 'Optional[GcpOauthToken]' = None, r2_temp_credentials: 'Optional[R2Credentials]' = None)

aws_temp_credentials: AwsCredentials | None = None

azure_aad: AzureActiveDirectoryToken | None = None

expiration_time: int | None = None

Server time when the credential will expire, in epoch milliseconds. The API client is advised to cache the credential given this expiration time.

gcp_oauth_token: GcpOauthToken | None = None

r2_temp_credentials: R2Credentials | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TemporaryCredentials from a dictionary.

class databricks.sdk.service.catalog.TriggeredUpdateStatus(last_processed_commit_version: int | None = None, timestamp: str | None = None, triggered_update_progress: PipelineProgress | None = None)

Detailed status of an online table. Shown if the online table is in the ONLINE_TRIGGERED_UPDATE or the ONLINE_NO_PENDING_UPDATE state.

last_processed_commit_version: int | None = None

The last source table Delta version that was synced to the online table. Note that this Delta version may not be completely synced to the online table yet.

timestamp: str | None = None

The timestamp of the last time any data was synchronized from the source table to the online table.

triggered_update_progress: PipelineProgress | None = None

Progress of the active data synchronization pipeline.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the TriggeredUpdateStatus from a dictionary.

class databricks.sdk.service.catalog.UnassignResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UnassignResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateAccountsMetastore(delta_sharing_organization_name: 'Optional[str]' = None, delta_sharing_recipient_token_lifetime_in_seconds: 'Optional[int]' = None, delta_sharing_scope: 'Optional[DeltaSharingScopeEnum]' = None, external_access_enabled: 'Optional[bool]' = None, owner: 'Optional[str]' = None, privilege_model_version: 'Optional[str]' = None, storage_root_credential_id: 'Optional[str]' = None)

delta_sharing_organization_name: str | None = None

The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.

delta_sharing_recipient_token_lifetime_in_seconds: int | None = None

The lifetime of delta sharing recipient token in seconds.

delta_sharing_scope: DeltaSharingScopeEnum | None = None

The scope of Delta Sharing enabled for the metastore.

external_access_enabled: bool | None = None

Whether to allow non-DBR clients to directly access entities under the metastore.

owner: str | None = None

The owner of the metastore.

privilege_model_version: str | None = None

Privilege model version of the metastore, of the form major.minor (e.g., 1.0).

storage_root_credential_id: str | None = None

UUID of storage credential to access the metastore storage_root.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateAccountsMetastore from a dictionary.

class databricks.sdk.service.catalog.UpdateAccountsStorageCredential(aws_iam_role: 'Optional[AwsIamRoleRequest]' = None, azure_managed_identity: 'Optional[AzureManagedIdentityResponse]' = None, azure_service_principal: 'Optional[AzureServicePrincipal]' = None, cloudflare_api_token: 'Optional[CloudflareApiToken]' = None, comment: 'Optional[str]' = None, databricks_gcp_service_account: 'Optional[DatabricksGcpServiceAccountRequest]' = None, isolation_mode: 'Optional[IsolationMode]' = None, owner: 'Optional[str]' = None, read_only: 'Optional[bool]' = None)

aws_iam_role: AwsIamRoleRequest | None = None

The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentityResponse | None = None

The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None

The Azure service principal configuration.

cloudflare_api_token: CloudflareApiToken | None = None

The Cloudflare API token configuration.

comment: str | None = None

Comment associated with the credential.

databricks_gcp_service_account: DatabricksGcpServiceAccountRequest | None = None

The Databricks managed GCP service account configuration.

isolation_mode: IsolationMode | None = None

Whether the current securable is accessible from all workspaces or a specific set of workspaces.

owner: str | None = None

Username of current owner of credential.

read_only: bool | None = None

Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateAccountsStorageCredential from a dictionary.

class databricks.sdk.service.catalog.UpdateAssignmentResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateAssignmentResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateCatalogWorkspaceBindingsResponse(workspaces: 'Optional[List[int]]' = None)

workspaces: List[int] | None = None

A list of workspace IDs

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateCatalogWorkspaceBindingsResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateMetastoreAssignment(workspace_id: 'int', default_catalog_name: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None)

workspace_id: int

A workspace ID.

default_catalog_name: str | None = None

The name of the default catalog in the metastore. This field is deprecated. Please use “Default Namespace API” to configure the default catalog for a Databricks workspace.

metastore_id: str | None = None

The unique ID of the metastore.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateMetastoreAssignment from a dictionary.

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

privilege_assignments: List[PrivilegeAssignment] | None = None

The privileges assigned to each principal

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdatePermissionsResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateRequestExternalLineage(source: 'ExternalLineageObject', target: 'ExternalLineageObject', columns: 'Optional[List[ColumnRelationship]]' = None, id: 'Optional[str]' = None, properties: 'Optional[Dict[str, str]]' = None)

source: ExternalLineageObject

Source object of the external lineage relationship.

target: ExternalLineageObject

Target object of the external lineage relationship.

columns: List[ColumnRelationship] | None = None

List of column relationships between source and target objects.

id: str | None = None

Unique identifier of the external lineage relationship.

properties: Dict[str, str] | None = None

Key-value properties associated with the external lineage relationship.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateRequestExternalLineage from a dictionary.

class databricks.sdk.service.catalog.UpdateResponse

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateWorkspaceBindingsResponse(bindings: List[WorkspaceBinding] | None = None)

A list of workspace IDs that are bound to the securable

bindings: List[WorkspaceBinding] | None = None

List of workspace bindings.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UpdateWorkspaceBindingsResponse from a dictionary.

class databricks.sdk.service.catalog.ValidateCredentialResponse(is_dir: 'Optional[bool]' = None, results: 'Optional[List[CredentialValidationResult]]' = None)

is_dir: bool | None = None

Whether the tested location is a directory in cloud storage. Only applicable for when purpose is STORAGE.

results: List[CredentialValidationResult] | None = None

The results of the validation check.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ValidateCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.ValidateCredentialResult

A enum represents the result of the file operation

FAIL = "FAIL"

PASS = "PASS"

SKIP = "SKIP"

class databricks.sdk.service.catalog.ValidateStorageCredentialResponse(is_dir: 'Optional[bool]' = None, results: 'Optional[List[ValidationResult]]' = None)

is_dir: bool | None = None

Whether the tested location is a directory in cloud storage.

results: List[ValidationResult] | None = None

The results of the validation check.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ValidateStorageCredentialResponse from a dictionary.

class databricks.sdk.service.catalog.ValidationResult(message: 'Optional[str]' = None, operation: 'Optional[ValidationResultOperation]' = None, result: 'Optional[ValidationResultResult]' = None)

message: str | None = None

Error message would exist when the result does not equal to PASS.

operation: ValidationResultOperation | None = None

The operation tested.

result: ValidationResultResult | None = None

The results of the tested operation.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ValidationResult from a dictionary.

class databricks.sdk.service.catalog.ValidationResultOperation

A enum represents the file operation performed on the external location with the storage credential

DELETE = "DELETE"

LIST = "LIST"

PATH_EXISTS = "PATH_EXISTS"

READ = "READ"

WRITE = "WRITE"

class databricks.sdk.service.catalog.ValidationResultResult

A enum represents the result of the file operation

FAIL = "FAIL"

PASS = "PASS"

SKIP = "SKIP"

class databricks.sdk.service.catalog.VolumeInfo(access_point: 'Optional[str]' = None, browse_only: 'Optional[bool]' = None, catalog_name: 'Optional[str]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, created_by: 'Optional[str]' = None, encryption_details: 'Optional[EncryptionDetails]' = None, full_name: 'Optional[str]' = None, metastore_id: 'Optional[str]' = None, name: 'Optional[str]' = None, owner: 'Optional[str]' = None, schema_name: 'Optional[str]' = None, storage_location: 'Optional[str]' = None, updated_at: 'Optional[int]' = None, updated_by: 'Optional[str]' = None, volume_id: 'Optional[str]' = None, volume_type: 'Optional[VolumeType]' = None)

access_point: str | None = None

The AWS access point to use when accesing s3 for this external location.

browse_only: bool | None = None

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None

The name of the catalog where the schema and the volume are

comment: str | None = None

The comment attached to the volume

created_at: int | None = None

created_by: str | None = None

The identifier of the user who created the volume

encryption_details: EncryptionDetails | None = None

full_name: str | None = None

The three-level (fully qualified) name of the volume

metastore_id: str | None = None

The unique identifier of the metastore

name: str | None = None

The name of the volume

owner: str | None = None

The identifier of the user who owns the volume

schema_name: str | None = None

The name of the schema where the volume is

storage_location: str | None = None

The storage location on the cloud

updated_at: int | None = None

updated_by: str | None = None

The identifier of the user who updated the volume last time

volume_id: str | None = None

The unique identifier of the volume

volume_type: VolumeType | None = None

The type of the volume. An external volume is located in the specified external location. A managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. [Learn more]

[Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the VolumeInfo from a dictionary.

class databricks.sdk.service.catalog.VolumeOperation

READ_VOLUME = "READ_VOLUME"

WRITE_VOLUME = "WRITE_VOLUME"

class databricks.sdk.service.catalog.VolumeType

EXTERNAL = "EXTERNAL"

MANAGED = "MANAGED"

class databricks.sdk.service.catalog.WorkspaceBinding(workspace_id: 'int', binding_type: 'Optional[WorkspaceBindingBindingType]' = None)

workspace_id: int

Required

binding_type: WorkspaceBindingBindingType | None = None

One of READ_WRITE/READ_ONLY. Default is READ_WRITE.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the WorkspaceBinding from a dictionary.

class databricks.sdk.service.catalog.WorkspaceBindingBindingType

Using BINDING_TYPE_ prefix here to avoid conflict with TableOperation enum in credentials_common.proto.

BINDING_TYPE_READ_ONLY = "BINDING_TYPE_READ_ONLY"

BINDING_TYPE_READ_WRITE = "BINDING_TYPE_READ_WRITE"