AtlasRelationshipDef Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
AtlasRelationshipDef is a TypeDef that defines a relationship. As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. The name and the guid are the 2 ways that the RelationshipDef is identified. RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally whether the end is a container. RelationshipDefs can have AttributeDefs - though only primitive types are allowed. RelationshipDefs have a relationshipCategory specifying the UML type of relationship required The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs will not specify an EntityDef type name as their types. RelationshipDefs introduce new attributes to the entity instances. For example EntityDef A might have attributes attr1,attr2,attr3
EntityDef B might have attributes attr4,attr5,attr6 RelationshipDef AtoB might define 2 ends
end1: type A, name attr7 end2: type B, name attr8
When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8
In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into the entity instances
public class AtlasRelationshipDef : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.Purview.DataMap.AtlasRelationshipDef>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.Purview.DataMap.AtlasRelationshipDef>
type AtlasRelationshipDef = class
interface IJsonModel<AtlasRelationshipDef>
interface IPersistableModel<AtlasRelationshipDef>
Public Class AtlasRelationshipDef
Implements IJsonModel(Of AtlasRelationshipDef), IPersistableModel(Of AtlasRelationshipDef)
- Inheritance
-
AtlasRelationshipDef
- Implements
Constructors
AtlasRelationshipDef() |
Initializes a new instance of AtlasRelationshipDef. |
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. |
Description |
The description of the type definition. |
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. |
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. |
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. |
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<AtlasRelationshipDef>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<AtlasRelationshipDef>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<AtlasRelationshipDef>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<AtlasRelationshipDef>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<AtlasRelationshipDef>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |