AtlasRelationship interface

Package:

@azure-rest/purview-datamap

Atlas relationship instance.

Properties

attributes	The attributes of the struct.
createdBy	The user who created the record.
createTime	The created time of the record.
end1	Reference to an object-instance of a type - like entity.
end2	Reference to an object-instance of a type - like entity.
guid	The GUID of the relationship.
homeId	The home ID of the relationship.
label	The label of the relationship.
lastModifiedTS	ETag for concurrency control.
provenanceType	Used to record the provenance of an instance of an entity or relationship
status	The enum of relationship status. Possible values: "ACTIVE", "DELETED"
typeName	The name of the type.
updatedBy	The user who updated the record.
updateTime	The update time of the record.
version	The version of the relationship.

Property Details

attributes

The attributes of the struct.

attributes?: Record<string, unknown>

Property Value

Record<string, unknown>

createdBy

The user who created the record.

createdBy?: string

Property Value

string

createTime

The created time of the record.

createTime?: number

Property Value

number

end1

Reference to an object-instance of a type - like entity.

end1?: AtlasObjectId

Property Value

AtlasObjectId

end2

Reference to an object-instance of a type - like entity.

end2?: AtlasObjectId

Property Value

AtlasObjectId

guid

The GUID of the relationship.

guid?: string

Property Value

string

homeId

The home ID of the relationship.

homeId?: string

Property Value

string

label

The label of the relationship.

label?: string

Property Value

string

lastModifiedTS

ETag for concurrency control.

lastModifiedTS?: string

Property Value

string

provenanceType

Used to record the provenance of an instance of an entity or relationship

provenanceType?: number

Property Value

number

status

The enum of relationship status.

Possible values: "ACTIVE", "DELETED"

status?: string

Property Value

string

typeName

The name of the type.

typeName?: 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 relationship.

version?: number

Property Value

number