AtlasRelatedObjectId interface

Package:

@azure-rest/purview-datamap

Reference to an object-instance of AtlasEntity type used in relationship attribute values

Properties

displayText	The display text.
entityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed. Possible values: "ACTIVE", "DELETED"
guid	The GUID of the object.
relationshipAttributes	Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
relationshipGuid	The GUID of the relationship.
relationshipStatus	The enum of relationship status. Possible values: "ACTIVE", "DELETED"
relationshipType	Relationship type
typeName	The name of the type.
uniqueAttributes	The unique attributes of the object.

Property Details

displayText

The display text.

displayText?: string

Property Value

string

entityStatus

Status of the entity - can be active or deleted. Deleted entities are not removed.

Possible values: "ACTIVE", "DELETED"

entityStatus?: string

Property Value

string

guid

The GUID of the object.

guid?: string

Property Value

string

relationshipAttributes

Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.

relationshipAttributes?: AtlasStruct

Property Value

AtlasStruct

relationshipGuid

The GUID of the relationship.

relationshipGuid?: string

Property Value

string

relationshipStatus

The enum of relationship status.

Possible values: "ACTIVE", "DELETED"

relationshipStatus?: string

Property Value

string

relationshipType

Relationship type

relationshipType?: string

Property Value

string

typeName

The name of the type.

typeName?: string

Property Value

string

uniqueAttributes

The unique attributes of the object.

uniqueAttributes?: Record<string, unknown>

Property Value

Record<string, unknown>