Catalog Config

View as Markdown

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)

GetGET /api/data-classification/v1/{name=catalogs/*/config}CreatePOST /api/data-classification/v1/{parent=catalogs/*}/configUpdatePATCH /api/data-classification/v1/{catalog_config.name=catalogs/*/config}DeleteDELETE /api/data-classification/v1/{name=catalogs/*/config}

CatalogConfig object

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)

namestring

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

included_schemasobject

Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excluded_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

Show child attributesHide child attributes

namesarray of string

Schema names, each relative to the parent catalog. Must not be empty.

excluded_schemasobject

Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with included_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

Show child attributesHide child attributes

namesarray of string

Schema names, each relative to the parent catalog. Must not be empty.

auto_tag_configsarray of object

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

Show child attributesHide child attributes

classification_tagstring

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_modestring

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

Values: AUTO_TAGGING_MODE_UNSPECIFIED, AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED

View as Markdown

The CatalogConfig object

{
  "name": "string",
  "included_schemas": {
    "names": [
      "string"
    ]
  },
  "excluded_schemas": {
    "names": [
      "string"
    ]
  },
  "auto_tag_configs": [
    {
      "classification_tag": "string",
      "auto_tagging_mode": "string"
    }
  ]
}

Get

GET /api/data-classification/v1/{name=catalogs/*/config}

Get the Data Classification configuration for a catalog.

API scopes: dataclassification

Parameters

namestringpath

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

Response

Returns the CatalogConfig object.

View as Markdown

Response

{
  "name": "string",
  "included_schemas": {
    "names": [
      "string"
    ]
  },
  "excluded_schemas": {
    "names": [
      "string"
    ]
  },
  "auto_tag_configs": [
    {
      "classification_tag": "string",
      "auto_tagging_mode": "string"
    }
  ]
}

Create

POST /api/data-classification/v1/{parent=catalogs/*}/config

Create Data Classification configuration for a catalog.

Creates a new config resource, which enables Data Classification for the specified catalog.

• The config must not already exist for the catalog.

API scopes: dataclassification

Parameters

parentstringpath

Parent resource in the format: catalogs/{catalog_name}

Request body

catalog_configobject

The configuration to create.

Show child attributesHide child attributes

namestring

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

included_schemasobjectRequired

Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excluded_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

Show child attributesHide child attributes

namesarray of string

Schema names, each relative to the parent catalog. Must not be empty.

excluded_schemasobjectRequired

Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with included_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

Show child attributesHide child attributes

namesarray of string

Schema names, each relative to the parent catalog. Must not be empty.

auto_tag_configsarray of object

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

Show child attributesHide child attributes

classification_tagstring

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_modestring

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

Values: AUTO_TAGGING_MODE_UNSPECIFIED, AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED

Response

Returns the CatalogConfig object.

View as Markdown

Request

{
  "catalog_config": {
    "name": "string",
    "included_schemas": {},
    "excluded_schemas": {},
    "auto_tag_configs": [
      {}
    ]
  }
}

Response

{
  "name": "string",
  "included_schemas": {
    "names": [
      "string"
    ]
  },
  "excluded_schemas": {
    "names": [
      "string"
    ]
  },
  "auto_tag_configs": [
    {
      "classification_tag": "string",
      "auto_tagging_mode": "string"
    }
  ]
}

Update

PATCH /api/data-classification/v1/{catalog_config.name=catalogs/*/config}

Update the Data Classification configuration for a catalog.

• The config must already exist for the catalog.
• Updates fields specified in the update_mask. Use update_mask field to perform partial updates of the configuration.

API scopes: dataclassification

Parameters

catalog_configobjectpath

The configuration to apply to the catalog. The name field in catalog_config identifies which resource to update.

Show child attributesHide child attributes

namestring

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

included_schemasobjectRequired

Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excluded_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

Show child attributesHide child attributes

namesarray of string

Schema names, each relative to the parent catalog. Must not be empty.

excluded_schemasobjectRequired

Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with included_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

Show child attributesHide child attributes

namesarray of string

Schema names, each relative to the parent catalog. Must not be empty.

auto_tag_configsarray of object

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

Show child attributesHide child attributes

classification_tagstring

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_modestring

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

Values: AUTO_TAGGING_MODE_UNSPECIFIED, AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED

update_maskstringquery

Field mask specifying which fields to update.

Response

Returns the CatalogConfig object.

View as Markdown

Response

{
  "name": "string",
  "included_schemas": {
    "names": [
      "string"
    ]
  },
  "excluded_schemas": {
    "names": [
      "string"
    ]
  },
  "auto_tag_configs": [
    {
      "classification_tag": "string",
      "auto_tagging_mode": "string"
    }
  ]
}

Delete

DELETE /api/data-classification/v1/{name=catalogs/*/config}

Delete Data Classification configuration for a catalog.

API scopes: dataclassification

Parameters

namestringpath

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

View as Markdown

Response

{}