AtlasEntityOutput interface

Package:

@azure-rest/purview-datamap

An instance of an entity - like hive_table, hive_database.

Properties

attributes	The attributes of the struct.
businessAttributes	Business attributes
classifications	An array of classifications.
collectionId	The collection ID of the entity.
contacts	The dictionary of contacts for entities. Key could be Expert or Owner.
createdBy	The user who created the record.
createTime	The created time of the record.
customAttributes	Custom Attribute
guid	The GUID of the entity.
homeId	The home ID of the entity.
isIncomplete	Whether it is a shell entity
labels	labels
lastModifiedTS	ETag for concurrency control.
meanings	An array of term assignment headers indicating the meanings of the entity.
provenanceType	Used to record the provenance of an instance of an entity or relationship.
proxy	Determines if there's a proxy.
relationshipAttributes	The attributes of relationship.
status	Status of the entity - can be active or deleted. Deleted entities are not removed. 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 entity.

Property Details

attributes

The attributes of the struct.

attributes?: Record<string, any>

Property Value

Record<string, any>

businessAttributes

Business attributes

businessAttributes?: Record<string, any>

Property Value

Record<string, any>

classifications

An array of classifications.

classifications?: AtlasClassificationOutput[]

Property Value

AtlasClassificationOutput[]

collectionId

The collection ID of the entity.

collectionId?: string

Property Value

string

contacts

The dictionary of contacts for entities. Key could be Expert or Owner.

contacts?: Record<string, ContactInfoOutput[]>

Property Value

Record<string, ContactInfoOutput[]>

createdBy

The user who created the record.

createdBy?: string

Property Value

string

createTime

The created time of the record.

createTime?: number

Property Value

number

customAttributes

Custom Attribute

customAttributes?: Record<string, string>

Property Value

Record<string, string>

guid

The GUID of the entity.

guid?: string

Property Value

string

homeId

The home ID of the entity.

homeId?: string

Property Value

string

isIncomplete

Whether it is a shell entity

isIncomplete?: boolean

Property Value

boolean

labels

labels

labels?: string[]

Property Value

string[]

lastModifiedTS

ETag for concurrency control.

lastModifiedTS?: string

Property Value

string

meanings

An array of term assignment headers indicating the meanings of the entity.

meanings?: AtlasTermAssignmentHeaderOutput[]

Property Value

AtlasTermAssignmentHeaderOutput[]

provenanceType

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

provenanceType?: number

Property Value

number

proxy

Determines if there's a proxy.

proxy?: boolean

Property Value

boolean

relationshipAttributes

The attributes of relationship.

relationshipAttributes?: Record<string, any>

Property Value

Record<string, any>

status

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

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 entity.

version?: number

Property Value

number