yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-24 07:14:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.1.x/main-concepts/metadata-standard/schemas/entity/classification/classification.md
Pere Miquel Brull 3afb5212ec
[Docs] - Use a.b.x as version pattern (#13161) 
* [Docs] - Use a.b.x as version pattern

* Fix image path
2023-09-12 19:41:21 +02:00

2.5 KiB
Raw Blame History

title slug
classification /main-concepts/metadata-standard/schemas/entity/classification/classification

Classification

A Classification entity contains hierarchical terms called tags used for categorizing and classifying data assets and other entities.

Properties

  • id: Unique identifier of this entity instance. Refer to ../../type/basic.json#/definitions/uuid.
  • name: Refer to tag.json#/definitions/tagName.
  • fullyQualifiedName: FullyQualifiedName same as name. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • displayName (string): Display Name that identifies this entity.
  • description: Description of the classification. Refer to ../../type/basic.json#/definitions/markdown.
  • version: Metadata version of the entity. Refer to ../../type/entityHistory.json#/definitions/entityVersion.
  • termCount (integer): Total number of children tag terms under this classification. This includes all the children in the hierarchy. Minimum: 0.
  • updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.
  • updatedBy (string): User who made the update.
  • href: Link to the resource corresponding to the classification. Refer to ../../type/basic.json#/definitions/href.
  • usageCount (integer): Count of how many times the tags from this classification are used.
  • changeDescription: Change that lead to this version of the entity. Refer to ../../type/entityHistory.json#/definitions/changeDescription.
  • deleted (boolean): When true indicates the entity has been soft deleted. Default: False.
  • provider: Refer to ../../type/basic.json#/definitions/providerType.
  • disabled (boolean): System classifications can't be deleted. Use this flag to disable them.
  • mutuallyExclusive (boolean): Tags under this classification are mutually exclusive. When mutually exclusive is true the tags from this classification are used to classify an entity. An entity can only be in one class - example, it can only be either tier1 or tier2 and not both. When mutually exclusive is false, the tags from this classification are used to categorize an entity. An entity have multiple tags simultaneously - example a customer can be newCustomer and atRisk simultaneously. Default: false.

Documentation file automatically generated at 2023-07-07 05:50:35.981927.