Package com.azure.analytics.purview.datamap.models

Class AtlasGlossaryTerm

java.lang.Object
com.azure.analytics.purview.datamap.models.AtlasGlossaryTerm
All Implemented Interfaces:
com.azure.json.JsonSerializable<AtlasGlossaryTerm>
public final class AtlasGlossaryTerm extends Object implements com.azure.json.JsonSerializable<AtlasGlossaryTerm>
The glossary term.

  • Constructor Details

    • AtlasGlossaryTerm

      public AtlasGlossaryTerm()
      Creates an instance of AtlasGlossaryTerm class.

  • Method Details

    • getGuid

      public String getGuid()
      Get the guid property: The GUID of the object.
      Returns:
      the guid value.

    • setGuid

      public AtlasGlossaryTerm setGuid(String guid)
      Set the guid property: The GUID of the object.
      Parameters:
      guid - the guid value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getClassifications

      public List<AtlasClassification> getClassifications()
      Get the classifications property: An array of classifications.
      Returns:
      the classifications value.

    • setClassifications

      public AtlasGlossaryTerm setClassifications(List<AtlasClassification> classifications)
      Set the classifications property: An array of classifications.
      Parameters:
      classifications - the classifications value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getLongDescription

      public String getLongDescription()
      Get the longDescription property: The long version description.
      Returns:
      the longDescription value.

    • setLongDescription

      public AtlasGlossaryTerm setLongDescription(String longDescription)
      Set the longDescription property: The long version description.
      Parameters:
      longDescription - the longDescription value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getName

      public String getName()
      Get the name property: The name of the glossary object.
      Returns:
      the name value.

    • setName

      public AtlasGlossaryTerm setName(String name)
      Set the name property: The name of the glossary object.
      Parameters:
      name - the name value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getQualifiedName

      public String getQualifiedName()
      Get the qualifiedName property: The qualified name of the glossary object.
      Returns:
      the qualifiedName value.

    • setQualifiedName

      public AtlasGlossaryTerm setQualifiedName(String qualifiedName)
      Set the qualifiedName property: The qualified name of the glossary object.
      Parameters:
      qualifiedName - the qualifiedName value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getShortDescription

      public String getShortDescription()
      Get the shortDescription property: The short version of description.
      Returns:
      the shortDescription value.

    • setShortDescription

      public AtlasGlossaryTerm setShortDescription(String shortDescription)
      Set the shortDescription property: The short version of description.
      Parameters:
      shortDescription - the shortDescription value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getLastModifiedTS

      public String getLastModifiedTS()
      Get the lastModifiedTS property: ETag for concurrency control.
      Returns:
      the lastModifiedTS value.

    • setLastModifiedTS

      public AtlasGlossaryTerm setLastModifiedTS(String lastModifiedTS)
      Set the lastModifiedTS property: ETag for concurrency control.
      Parameters:
      lastModifiedTS - the lastModifiedTS value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getCreateTime

      public Long getCreateTime()
      Get the createTime property: The created time of the record.
      Returns:
      the createTime value.

    • setCreateTime

      public AtlasGlossaryTerm setCreateTime(Long createTime)
      Set the createTime property: The created time of the record.
      Parameters:
      createTime - the createTime value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getCreatedBy

      public String getCreatedBy()
      Get the createdBy property: The user who created the record.
      Returns:
      the createdBy value.

    • setCreatedBy

      public AtlasGlossaryTerm setCreatedBy(String createdBy)
      Set the createdBy property: The user who created the record.
      Parameters:
      createdBy - the createdBy value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getUpdateTime

      public Long getUpdateTime()
      Get the updateTime property: The update time of the record.
      Returns:
      the updateTime value.

    • setUpdateTime

      public AtlasGlossaryTerm setUpdateTime(Long updateTime)
      Set the updateTime property: The update time of the record.
      Parameters:
      updateTime - the updateTime value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getUpdatedBy

      public String getUpdatedBy()
      Get the updatedBy property: The user who updated the record.
      Returns:
      the updatedBy value.

    • setUpdatedBy

      public AtlasGlossaryTerm setUpdatedBy(String updatedBy)
      Set the updatedBy property: The user who updated the record.
      Parameters:
      updatedBy - the updatedBy value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getAbbreviation

      public String getAbbreviation()
      Get the abbreviation property: The abbreviation of the term.
      Returns:
      the abbreviation value.

    • setAbbreviation

      public AtlasGlossaryTerm setAbbreviation(String abbreviation)
      Set the abbreviation property: The abbreviation of the term.
      Parameters:
      abbreviation - the abbreviation value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getTemplateName

      public List<com.azure.core.util.BinaryData> getTemplateName()
      Get the templateName property: The name of the template.
      Returns:
      the templateName value.

    • setTemplateName

      public AtlasGlossaryTerm setTemplateName(List<com.azure.core.util.BinaryData> templateName)
      Set the templateName property: The name of the template.
      Parameters:
      templateName - the templateName value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getAnchor

      public AtlasGlossaryHeader getAnchor()
      Get the anchor property: The glossary header with basic information.
      Returns:
      the anchor value.

    • setAnchor

      public AtlasGlossaryTerm setAnchor(AtlasGlossaryHeader anchor)
      Set the anchor property: The glossary header with basic information.
      Parameters:
      anchor - the anchor value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getAntonyms

      public List<AtlasRelatedTermHeader> getAntonyms()
      Get the antonyms property: An array of related term headers as antonyms.
      Returns:
      the antonyms value.

    • setAntonyms

      public AtlasGlossaryTerm setAntonyms(List<AtlasRelatedTermHeader> antonyms)
      Set the antonyms property: An array of related term headers as antonyms.
      Parameters:
      antonyms - the antonyms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getStatus

      public TermStatus getStatus()
      Get the status property: Status of the AtlasGlossaryTerm.
      Returns:
      the status value.

    • setStatus

      public AtlasGlossaryTerm setStatus(TermStatus status)
      Set the status property: Status of the AtlasGlossaryTerm.
      Parameters:
      status - the status value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getNickName

      public String getNickName()
      Get the nickName property: The nick name of the term.
      Returns:
      the nickName value.

    • setNickName

      public AtlasGlossaryTerm setNickName(String nickName)
      Set the nickName property: The nick name of the term.
      Parameters:
      nickName - the nickName value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getHierarchyInfo

      public List<PurviewObjectId> getHierarchyInfo()
      Get the hierarchyInfo property: The hierarchy information of the term.
      Returns:
      the hierarchyInfo value.

    • setHierarchyInfo

      public AtlasGlossaryTerm setHierarchyInfo(List<PurviewObjectId> hierarchyInfo)
      Set the hierarchyInfo property: The hierarchy information of the term.
      Parameters:
      hierarchyInfo - the hierarchyInfo value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getResources

      public List<ResourceLink> getResources()
      Get the resources property: An array of resource link for term.
      Returns:
      the resources value.

    • setResources

      public AtlasGlossaryTerm setResources(List<ResourceLink> resources)
      Set the resources property: An array of resource link for term.
      Parameters:
      resources - the resources value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getContacts

      public Map<String,List<ContactInfo>> getContacts()
      Get the contacts property: The dictionary of contacts for terms. Key could be Expert or Steward.
      Returns:
      the contacts value.

    • setContacts

      public AtlasGlossaryTerm setContacts(Map<String,List<ContactInfo>> contacts)
      Set the contacts property: The dictionary of contacts for terms. Key could be Expert or Steward.
      Parameters:
      contacts - the contacts value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getAttributes

      public Map<String,Map<String,com.azure.core.util.BinaryData>> getAttributes()
      Get the attributes property: The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.
      Returns:
      the attributes value.

    • setAttributes

      public AtlasGlossaryTerm setAttributes(Map<String,Map<String,com.azure.core.util.BinaryData>> attributes)
      Set the attributes property: The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.
      Parameters:
      attributes - the attributes value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getAssignedEntities

      public List<AtlasRelatedObjectId> getAssignedEntities()
      Get the assignedEntities property: An array of related object IDs.
      Returns:
      the assignedEntities value.

    • setAssignedEntities

      public AtlasGlossaryTerm setAssignedEntities(List<AtlasRelatedObjectId> assignedEntities)
      Set the assignedEntities property: An array of related object IDs.
      Parameters:
      assignedEntities - the assignedEntities value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getCategories

      public List<AtlasTermCategorizationHeader> getCategories()
      Get the categories property: An array of term categorization headers.
      Returns:
      the categories value.

    • setCategories

      public AtlasGlossaryTerm setCategories(List<AtlasTermCategorizationHeader> categories)
      Set the categories property: An array of term categorization headers.
      Parameters:
      categories - the categories value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getClassifies

      public List<AtlasRelatedTermHeader> getClassifies()
      Get the classifies property: An array of related term headers.
      Returns:
      the classifies value.

    • setClassifies

      public AtlasGlossaryTerm setClassifies(List<AtlasRelatedTermHeader> classifies)
      Set the classifies property: An array of related term headers.
      Parameters:
      classifies - the classifies value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getExamples

      public List<String> getExamples()
      Get the examples property: An array of examples.
      Returns:
      the examples value.

    • setExamples

      public AtlasGlossaryTerm setExamples(List<String> examples)
      Set the examples property: An array of examples.
      Parameters:
      examples - the examples value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getIsA

      public List<AtlasRelatedTermHeader> getIsA()
      Get the isA property: An array of related term headers indicating the is-a relationship.
      Returns:
      the isA value.

    • setIsA

      public AtlasGlossaryTerm setIsA(List<AtlasRelatedTermHeader> isA)
      Set the isA property: An array of related term headers indicating the is-a relationship.
      Parameters:
      isA - the isA value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getPreferredTerms

      public List<AtlasRelatedTermHeader> getPreferredTerms()
      Get the preferredTerms property: An array of preferred related term headers.
      Returns:
      the preferredTerms value.

    • setPreferredTerms

      public AtlasGlossaryTerm setPreferredTerms(List<AtlasRelatedTermHeader> preferredTerms)
      Set the preferredTerms property: An array of preferred related term headers.
      Parameters:
      preferredTerms - the preferredTerms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getPreferredToTerms

      public List<AtlasRelatedTermHeader> getPreferredToTerms()
      Get the preferredToTerms property: An array of related term headers that are preferred to.
      Returns:
      the preferredToTerms value.

    • setPreferredToTerms

      public AtlasGlossaryTerm setPreferredToTerms(List<AtlasRelatedTermHeader> preferredToTerms)
      Set the preferredToTerms property: An array of related term headers that are preferred to.
      Parameters:
      preferredToTerms - the preferredToTerms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getReplacedBy

      public List<AtlasRelatedTermHeader> getReplacedBy()
      Get the replacedBy property: An array of related term headers that are replaced by.
      Returns:
      the replacedBy value.

    • setReplacedBy

      public AtlasGlossaryTerm setReplacedBy(List<AtlasRelatedTermHeader> replacedBy)
      Set the replacedBy property: An array of related term headers that are replaced by.
      Parameters:
      replacedBy - the replacedBy value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getReplacementTerms

      public List<AtlasRelatedTermHeader> getReplacementTerms()
      Get the replacementTerms property: An array of related term headers for replacement.
      Returns:
      the replacementTerms value.

    • setReplacementTerms

      public AtlasGlossaryTerm setReplacementTerms(List<AtlasRelatedTermHeader> replacementTerms)
      Set the replacementTerms property: An array of related term headers for replacement.
      Parameters:
      replacementTerms - the replacementTerms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getSeeAlso

      public List<AtlasRelatedTermHeader> getSeeAlso()
      Get the seeAlso property: An array of related term headers for see also.
      Returns:
      the seeAlso value.

    • setSeeAlso

      public AtlasGlossaryTerm setSeeAlso(List<AtlasRelatedTermHeader> seeAlso)
      Set the seeAlso property: An array of related term headers for see also.
      Parameters:
      seeAlso - the seeAlso value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getSynonyms

      public List<AtlasRelatedTermHeader> getSynonyms()
      Get the synonyms property: An array of related term headers as synonyms.
      Returns:
      the synonyms value.

    • setSynonyms

      public AtlasGlossaryTerm setSynonyms(List<AtlasRelatedTermHeader> synonyms)
      Set the synonyms property: An array of related term headers as synonyms.
      Parameters:
      synonyms - the synonyms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getTranslatedTerms

      public List<AtlasRelatedTermHeader> getTranslatedTerms()
      Get the translatedTerms property: An array of translated related term headers.
      Returns:
      the translatedTerms value.

    • setTranslatedTerms

      public AtlasGlossaryTerm setTranslatedTerms(List<AtlasRelatedTermHeader> translatedTerms)
      Set the translatedTerms property: An array of translated related term headers.
      Parameters:
      translatedTerms - the translatedTerms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getTranslationTerms

      public List<AtlasRelatedTermHeader> getTranslationTerms()
      Get the translationTerms property: An array of related term headers for translation.
      Returns:
      the translationTerms value.

    • setTranslationTerms

      public AtlasGlossaryTerm setTranslationTerms(List<AtlasRelatedTermHeader> translationTerms)
      Set the translationTerms property: An array of related term headers for translation.
      Parameters:
      translationTerms - the translationTerms value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getUsage

      public String getUsage()
      Get the usage property: The usage of the term.
      Returns:
      the usage value.

    • setUsage

      public AtlasGlossaryTerm setUsage(String usage)
      Set the usage property: The usage of the term.
      Parameters:
      usage - the usage value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getValidValues

      public List<AtlasRelatedTermHeader> getValidValues()
      Get the validValues property: An array of related term headers as valid values.
      Returns:
      the validValues value.

    • setValidValues

      public AtlasGlossaryTerm setValidValues(List<AtlasRelatedTermHeader> validValues)
      Set the validValues property: An array of related term headers as valid values.
      Parameters:
      validValues - the validValues value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • getValidValuesFor

      public List<AtlasRelatedTermHeader> getValidValuesFor()
      Get the validValuesFor property: An array of related term headers as valid values for other records.
      Returns:
      the validValuesFor value.

    • setValidValuesFor

      public AtlasGlossaryTerm setValidValuesFor(List<AtlasRelatedTermHeader> validValuesFor)
      Set the validValuesFor property: An array of related term headers as valid values for other records.
      Parameters:
      validValuesFor - the validValuesFor value to set.
      Returns:
      the AtlasGlossaryTerm object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AtlasGlossaryTerm>
      Throws:
      IOException

    • fromJson

      public static AtlasGlossaryTerm fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AtlasGlossaryTerm from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AtlasGlossaryTerm if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the AtlasGlossaryTerm.