Data Classification

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

class databricks.sdk.service.dataclassification.AutoTaggingConfig(classification_tag: str, auto_tagging_mode: AutoTaggingConfigAutoTaggingMode)

Auto-tagging configuration for a classification tag. When enabled, detected columns are automatically tagged with Unity Catalog tags.

classification_tag: str

The Classification Tag. For built-in classes this is a system tag (e.g., “class.name”, “class.location”); for custom classes it is a user-defined governance tag key.

auto_tagging_mode: AutoTaggingConfigAutoTaggingMode

Whether auto-tagging is enabled or disabled for this classification tag.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AutoTaggingConfig from a dictionary.

class databricks.sdk.service.dataclassification.AutoTaggingConfigAutoTaggingMode

Auto-tagging mode.

AUTO_TAGGING_DISABLED = "AUTO_TAGGING_DISABLED"

AUTO_TAGGING_ENABLED = "AUTO_TAGGING_ENABLED"

class databricks.sdk.service.dataclassification.CatalogConfig(auto_tag_configs: List[AutoTaggingConfig] | None = None, included_schemas: CatalogConfigSchemaNames | None = None, name: str | None = None)

Data Classification configuration for a Unity Catalog catalog. This message follows the “At Most One Resource” pattern: at most one CatalogConfig exists per catalog. - Full CRUD operations are supported: Create enables Data Classification, Delete disables it - It has no unique identifier of its own and uses its parent catalog’s identifier (catalog_name)

auto_tag_configs: List[AutoTaggingConfig] | None = None

List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled.

included_schemas: CatalogConfigSchemaNames | None = None

Schemas to include in the scan. Empty list is not supported as it results in a no-op scan. If included_schemas is not set, all schemas are scanned.

name: str | None = None

Resource name in the format: catalogs/{catalog_name}/config.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CatalogConfig from a dictionary.

class databricks.sdk.service.dataclassification.CatalogConfigSchemaNames(names: List[str])

Wrapper message for a list of schema names.

names: List[str]

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CatalogConfigSchemaNames from a dictionary.