Share via


AtlasTypeDef Class

Definition

The definitions of type.

public class AtlasTypeDef : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.Purview.DataMap.AtlasTypeDef>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.Purview.DataMap.AtlasTypeDef>
type AtlasTypeDef = class
    interface IJsonModel<AtlasTypeDef>
    interface IPersistableModel<AtlasTypeDef>
Public Class AtlasTypeDef
Implements IJsonModel(Of AtlasTypeDef), IPersistableModel(Of AtlasTypeDef)
Inheritance
AtlasTypeDef
Implements

Properties

AttributeDefs

An array of attribute definitions.

Category

The enum of type category.

CreatedBy

The user who created the record.

CreateTime

The created time of the record.

DateFormatter

The date format.

DefaultValue

The default value.

Description

The description of the type definition.

ElementDefs

An array of enum element definitions.

EndDef1

The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.

EndDef2

The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.

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.

RelationshipAttributeDefs

An array of relationship attributes.

RelationshipCategory

The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values.

ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships.

The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent.

RelationshipLabel

The label of the relationship.

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.

Explicit Interface Implementations

IJsonModel<AtlasTypeDef>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AtlasTypeDef>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AtlasTypeDef>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AtlasTypeDef>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AtlasTypeDef>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to