dataclassification

type AutoTaggingConfig ¶

type AutoTaggingConfig struct {
	// 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.
	ClassificationTag *string
	// Whether auto-tagging is enabled or disabled for this classification tag.
	AutoTaggingMode AutoTaggingConfig_AutoTaggingMode
}

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

type AutoTaggingConfig_AutoTaggingMode ¶

type AutoTaggingConfig_AutoTaggingMode string

Auto-tagging mode.

const (
	AutoTaggingConfig_AutoTaggingMode_Unspecified         AutoTaggingConfig_AutoTaggingMode = ""
	AutoTaggingConfig_AutoTaggingMode_AutoTaggingDisabled AutoTaggingConfig_AutoTaggingMode = "AUTO_TAGGING_DISABLED"
	AutoTaggingConfig_AutoTaggingMode_AutoTaggingEnabled  AutoTaggingConfig_AutoTaggingMode = "AUTO_TAGGING_ENABLED"
)

type CatalogConfig ¶

type CatalogConfig struct {
	// Resource name in the format: catalogs/{catalog_name}/config.
	Name            *string `fieldmask:"name"`
	SelectedSchemas isCatalogConfig_SelectedSchemas
	// List of auto-tagging configurations for this catalog. Empty list means no
	// auto-tagging is enabled.
	AutoTagConfigs []AutoTaggingConfig `fieldmask:"auto_tag_configs"`
	// contains filtered or unexported fields
}

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

type CatalogConfig_SchemaNames ¶

type CatalogConfig_SchemaNames struct {
	// Schema names, each relative to the parent catalog. Must not be empty.
	Names []string `fieldmask:"names"`
}

Wrapper message for a list of schema names..

type CatalogConfig_SelectedSchemas_ExcludedSchemas ¶

type CatalogConfig_SelectedSchemas_ExcludedSchemas struct {
	ExcludedSchemas CatalogConfig_SchemaNames `fieldmask:"excluded_schemas"`
}

CatalogConfig_SelectedSchemas_ExcludedSchemas selects ExcludedSchemas for CatalogConfig.SelectedSchemas. 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.

type CatalogConfig_SelectedSchemas_IncludedSchemas ¶

type CatalogConfig_SelectedSchemas_IncludedSchemas struct {
	IncludedSchemas CatalogConfig_SchemaNames `fieldmask:"included_schemas"`
}

CatalogConfig_SelectedSchemas_IncludedSchemas selects IncludedSchemas for CatalogConfig.SelectedSchemas. 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.

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient(ctx context.Context, opts ...client.Option) (*Client, error)

func (c *Client) CreateCatalogConfig(ctx context.Context, req CreateCatalogConfigRequest, opts ...call.Option) (*CatalogConfig, error)

func (c *Client) DeleteCatalogConfig(ctx context.Context, req DeleteCatalogConfigRequest, opts ...call.Option) error

func (c *Client) GetCatalogConfig(ctx context.Context, req GetCatalogConfigRequest, opts ...call.Option) (*CatalogConfig, error)

func (c *Client) UpdateCatalogConfig(ctx context.Context, req UpdateCatalogConfigRequest, opts ...call.Option) (*CatalogConfig, error)

type CreateCatalogConfigRequest ¶

type CreateCatalogConfigRequest struct {
	// Parent resource in the format: catalogs/{catalog_name}
	Parent *string
	// The configuration to create.
	CatalogConfig *CatalogConfig
}

Create Data Classification configuration for a catalog. Creating a config enables Data Classification for the catalog..

type DeleteCatalogConfigRequest ¶

type DeleteCatalogConfigRequest struct {
	// Resource name in the format: catalogs/{catalog_name}/config
	Name *string
}

Delete Data Classification configuration for a catalog. Deleting the config disables Data Classification for the catalog..

type GetCatalogConfigRequest ¶

type GetCatalogConfigRequest struct {
	// Resource name in the format: catalogs/{catalog_name}/config
	Name *string
}

Get Data Classification configuration for a catalog..

type UpdateCatalogConfigRequest ¶

type UpdateCatalogConfigRequest struct {
	// The configuration to apply to the catalog. The name field in catalog_config
	// identifies which resource to update.
	CatalogConfig *CatalogConfig
	// Field mask specifying which fields to update.
	UpdateMask *types.FieldMask[CatalogConfig]
}

Request to update the Data Classification configuration for a catalog.

Uses field mask to support partial updates of the configuration. Only the fields specified in the update_mask will be modified..