Share via


AtlasGlossaryTerm Class

Definition

The glossary term.

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

Constructors

AtlasGlossaryTerm()

Initializes a new instance of AtlasGlossaryTerm.

Properties

Abbreviation

The abbreviation of the term.

Anchor

The glossary header with basic information.

Antonyms

An array of related term headers as antonyms.

AssignedEntities

An array of related object IDs.

Attributes

The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.

Categories

An array of term categorization headers.

Classifications

An array of classifications.

Classifies

An array of related term headers.

Contacts

The dictionary of contacts for terms. Key could be Expert or Steward.

CreatedBy

The user who created the record.

CreateTime

The created time of the record.

Examples

An array of examples.

Guid

The GUID of the object.

HierarchyInfo

The hierarchy information of the term.

IsA

An array of related term headers indicating the is-a relationship.

LastModifiedTS

ETag for concurrency control.

LongDescription

The long version description.

Name

The name of the glossary object.

NickName

The nick name of the term.

PreferredTerms

An array of preferred related term headers.

PreferredToTerms

An array of related term headers that are preferred to.

QualifiedName

The qualified name of the glossary object.

ReplacedBy

An array of related term headers that are replaced by.

ReplacementTerms

An array of related term headers for replacement.

Resources

An array of resource link for term.

SeeAlso

An array of related term headers for see also.

ShortDescription

The short version of description.

Status

Status of the AtlasGlossaryTerm.

Synonyms

An array of related term headers as synonyms.

TemplateName

The name of the template.

To assign an object to the element 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" }.

TranslatedTerms

An array of translated related term headers.

TranslationTerms

An array of related term headers for translation.

UpdatedBy

The user who updated the record.

UpdateTime

The update time of the record.

Usage

The usage of the term.

ValidValues

An array of related term headers as valid values.

ValidValuesFor

An array of related term headers as valid values for other records.

Explicit Interface Implementations

IJsonModel<AtlasGlossaryTerm>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AtlasGlossaryTerm>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AtlasGlossaryTerm>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AtlasGlossaryTerm>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AtlasGlossaryTerm>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to