AtlasClassificationDef interface

Package:

@azure-rest/purview-datamap

class that captures details of a classification-type.

Properties

attributeDefs	An array of attribute definitions.
category	The enum of type category. Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE"
createdBy	The user who created the record.
createTime	The created time of the record.
dateFormatter	The date format.
description	The description of the type definition.
entityTypes	Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs.
guid	The GUID of the type definition.
lastModifiedTS	ETag for concurrency control.
name	The name of the type definition.
options	The options for the type definition.
serviceType	The service type.
subTypes	An array of sub types.
superTypes	An array of super types.
typeVersion	The version of the type.
updatedBy	The user who updated the record.
updateTime	The update time of the record.
version	The version of the record.

Property Details

attributeDefs

An array of attribute definitions.

attributeDefs?: AtlasAttributeDef[]

Property Value

AtlasAttributeDef[]

category

The enum of type category.

Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE"

category?: string

Property Value

string

createdBy

The user who created the record.

createdBy?: string

Property Value

string

createTime

The created time of the record.

createTime?: number

Property Value

number

dateFormatter

The date format.

dateFormatter?: DateFormat

Property Value

DateFormat

description

The description of the type definition.

description?: string

Property Value

string

entityTypes

Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes.

Any subtypes of the entity types inherit the restriction.

Any classificationDef subtypes inherit the parents entityTypes restrictions.

Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes.

An empty entityTypes list when there are no parent restrictions means there are no restrictions.

An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions.

If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs.

entityTypes?: string[]

Property Value

string[]

guid

The GUID of the type definition.

guid?: string

Property Value

string

lastModifiedTS

ETag for concurrency control.

lastModifiedTS?: string

Property Value

string

name

The name of the type definition.

name?: string

Property Value

string

options

The options for the type definition.

options?: Record<string, string>

Property Value

Record<string, string>

serviceType

The service type.

serviceType?: string

Property Value

string

subTypes

An array of sub types.

subTypes?: string[]

Property Value

string[]

superTypes

An array of super types.

superTypes?: string[]

Property Value

string[]

typeVersion

The version of the type.

typeVersion?: string

Property Value

string

updatedBy

The user who updated the record.

updatedBy?: string

Property Value

string

updateTime

The update time of the record.

updateTime?: number

Property Value

number

version

The version of the record.

version?: number

Property Value

number