AtlasEntity Class

Definition

An instance of an entity - like hive_table, hive_database.

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

Constructors

AtlasEntity()

Initializes a new instance of AtlasEntity.

Properties

Attributes

The attributes of the struct.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

BusinessAttributes

Business attributes

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Status

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

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.

Explicit Interface Implementations

IJsonModel<AtlasEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AtlasEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AtlasEntity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AtlasEntity>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AtlasEntity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to