Package com.atlan.model.assets

Interface IGlossaryTerm

All Known Implementing Classes:
GlossaryAntonym.Antonym, GlossaryIsA.Classify, GlossaryIsA.IsA, GlossaryPreferredTerm.PreferredTerm, GlossaryPreferredTerm.PreferredToTerm, GlossaryRelatedTerm.SeeAlso, GlossaryReplacementTerm.ReplacedBy, GlossaryReplacementTerm.ReplacementTerm, GlossarySemanticAssignment.AssignedTerm, GlossarySynonym.Synonym, GlossaryTerm, GlossaryTermCategorization.Term, GlossaryTranslation.TranslatedTerm, GlossaryTranslation.TranslationTerm, GlossaryValidValue.ValidValue, GlossaryValidValue.ValidValuesFor
@Generated("com.atlan.generators.ModelGeneratorV2") public interface IGlossaryTerm
Instance of a term in Atlan. Terms define concepts in natural language that can be associated with other assets to provide meaning.

  • Field Details

    • TYPE_NAME

      static final String TYPE_NAME
      See Also:

    • ABBREVIATION

      static final TextField ABBREVIATION
      TBC

    • ADDITIONAL_ATTRIBUTES

      static final KeywordField ADDITIONAL_ATTRIBUTES
      TBC

    • ANTONYMS

      static final RelationField ANTONYMS
      TBC

    • ASSIGNED_ENTITIES

      static final RelationField ASSIGNED_ENTITIES
      TBC

    • CLASSIFIES

      static final RelationField CLASSIFIES
      TBC

    • EXAMPLES

      static final TextField EXAMPLES
      TBC

    • IS_A

      static final RelationField IS_A
      TBC

    • LONG_DESCRIPTION

      static final TextField LONG_DESCRIPTION
      TBC

    • PREFERRED_TERMS

      static final RelationField PREFERRED_TERMS
      TBC

    • PREFERRED_TO_TERMS

      static final RelationField PREFERRED_TO_TERMS
      TBC

    • REPLACED_BY

      static final RelationField REPLACED_BY
      TBC

    • REPLACEMENT_TERMS

      static final RelationField REPLACEMENT_TERMS
      TBC

    • SEE_ALSO

      static final RelationField SEE_ALSO
      TBC

    • SHORT_DESCRIPTION

      static final TextField SHORT_DESCRIPTION
      TBC

    • SYNONYMS

      static final RelationField SYNONYMS
      TBC

    • TERM_TYPE

      static final KeywordField TERM_TYPE
      TBC

    • TRANSLATED_TERMS

      static final RelationField TRANSLATED_TERMS
      TBC

    • TRANSLATION_TERMS

      static final RelationField TRANSLATION_TERMS
      TBC

    • USAGE

      static final TextField USAGE
      TBC

    • VALID_VALUES

      static final RelationField VALID_VALUES
      TBC

    • VALID_VALUES_FOR

      static final RelationField VALID_VALUES_FOR
      TBC

    • ANCHOR

      static final KeywordField ANCHOR
      Glossary in which the term is contained, searchable by the qualifiedName of the glossary.

    • CATEGORIES

      static final KeywordField CATEGORIES
      Categories in which the term is organized, searchable by the qualifiedName of the category.

  • Method Details

    • getAbbreviation

      String getAbbreviation()
      TBC

    • getAdditionalAttributes

      Map<String,String> getAdditionalAttributes()
      TBC

    • getAdminGroups

      SortedSet<String> getAdminGroups()
      TBC

    • getAdminRoles

      SortedSet<String> getAdminRoles()
      TBC

    • getAdminUsers

      SortedSet<String> getAdminUsers()
      TBC

    • getAnchor

      IGlossary getAnchor()
      TBC

    • getAnnouncementMessage

      String getAnnouncementMessage()
      TBC

    • getAnnouncementTitle

      String getAnnouncementTitle()
      TBC

    • getAnnouncementType

      AtlanAnnouncementType getAnnouncementType()
      TBC

    • getAnnouncementUpdatedAt

      Long getAnnouncementUpdatedAt()
      TBC

    • getAnnouncementUpdatedBy

      String getAnnouncementUpdatedBy()
      TBC

    • getAnomaloChecks

      SortedSet<IAnomaloCheck> getAnomaloChecks()
      TBC

    • getAntonyms

      SortedSet<IGlossaryTerm> getAntonyms()
      TBC

    • getAssetAnomaloAppliedCheckTypes

      SortedSet<String> getAssetAnomaloAppliedCheckTypes()
      TBC

    • getAssetAnomaloCheckCount

      Long getAssetAnomaloCheckCount()
      TBC

    • getAssetAnomaloCheckStatuses

      String getAssetAnomaloCheckStatuses()
      TBC

    • getAssetAnomaloDQStatus

      String getAssetAnomaloDQStatus()
      TBC

    • getAssetAnomaloFailedCheckCount

      Long getAssetAnomaloFailedCheckCount()
      TBC

    • getAssetAnomaloFailedCheckTypes

      SortedSet<String> getAssetAnomaloFailedCheckTypes()
      TBC

    • getAssetAnomaloLastCheckRunAt

      Long getAssetAnomaloLastCheckRunAt()
      TBC

    • getAssetAnomaloSourceUrl

      String getAssetAnomaloSourceUrl()
      TBC

    • getAssetCoverImage

      String getAssetCoverImage()
      TBC

    • getAssetDbtAccountName

      String getAssetDbtAccountName()
      TBC

    • getAssetDbtAlias

      String getAssetDbtAlias()
      TBC

    • getAssetDbtEnvironmentDbtVersion

      String getAssetDbtEnvironmentDbtVersion()
      TBC

    • getAssetDbtEnvironmentName

      String getAssetDbtEnvironmentName()
      TBC

    • getAssetDbtJobLastRun

      Long getAssetDbtJobLastRun()
      TBC

    • getAssetDbtJobLastRunArtifactS3Path

      String getAssetDbtJobLastRunArtifactS3Path()
      TBC

    • getAssetDbtJobLastRunArtifactsSaved

      Boolean getAssetDbtJobLastRunArtifactsSaved()
      TBC

    • getAssetDbtJobLastRunCreatedAt

      Long getAssetDbtJobLastRunCreatedAt()
      TBC

    • getAssetDbtJobLastRunDequedAt

      Long getAssetDbtJobLastRunDequedAt()
      TBC

    • getAssetDbtJobLastRunExecutedByThreadId

      String getAssetDbtJobLastRunExecutedByThreadId()
      TBC

    • getAssetDbtJobLastRunGitBranch

      String getAssetDbtJobLastRunGitBranch()
      TBC

    • getAssetDbtJobLastRunGitSha

      String getAssetDbtJobLastRunGitSha()
      TBC

    • getAssetDbtJobLastRunHasDocsGenerated

      Boolean getAssetDbtJobLastRunHasDocsGenerated()
      TBC

    • getAssetDbtJobLastRunHasSourcesGenerated

      Boolean getAssetDbtJobLastRunHasSourcesGenerated()
      TBC

    • getAssetDbtJobLastRunNotificationsSent

      Boolean getAssetDbtJobLastRunNotificationsSent()
      TBC

    • getAssetDbtJobLastRunOwnerThreadId

      String getAssetDbtJobLastRunOwnerThreadId()
      TBC

    • getAssetDbtJobLastRunQueuedDuration

      String getAssetDbtJobLastRunQueuedDuration()
      TBC

    • getAssetDbtJobLastRunQueuedDurationHumanized

      String getAssetDbtJobLastRunQueuedDurationHumanized()
      TBC

    • getAssetDbtJobLastRunRunDuration

      String getAssetDbtJobLastRunRunDuration()
      TBC

    • getAssetDbtJobLastRunRunDurationHumanized

      String getAssetDbtJobLastRunRunDurationHumanized()
      TBC

    • getAssetDbtJobLastRunStartedAt

      Long getAssetDbtJobLastRunStartedAt()
      TBC

    • getAssetDbtJobLastRunStatusMessage

      String getAssetDbtJobLastRunStatusMessage()
      TBC

    • getAssetDbtJobLastRunTotalDuration

      String getAssetDbtJobLastRunTotalDuration()
      TBC

    • getAssetDbtJobLastRunTotalDurationHumanized

      String getAssetDbtJobLastRunTotalDurationHumanized()
      TBC

    • getAssetDbtJobLastRunUpdatedAt

      Long getAssetDbtJobLastRunUpdatedAt()
      TBC

    • getAssetDbtJobLastRunUrl

      String getAssetDbtJobLastRunUrl()
      TBC

    • getAssetDbtJobName

      String getAssetDbtJobName()
      TBC

    • getAssetDbtJobNextRun

      Long getAssetDbtJobNextRun()
      TBC

    • getAssetDbtJobNextRunHumanized

      String getAssetDbtJobNextRunHumanized()
      TBC

    • getAssetDbtJobSchedule

      String getAssetDbtJobSchedule()
      TBC

    • getAssetDbtJobScheduleCronHumanized

      String getAssetDbtJobScheduleCronHumanized()
      TBC

    • getAssetDbtJobStatus

      String getAssetDbtJobStatus()
      TBC

    • getAssetDbtMeta

      String getAssetDbtMeta()
      TBC

    • getAssetDbtPackageName

      String getAssetDbtPackageName()
      TBC

    • getAssetDbtProjectName

      String getAssetDbtProjectName()
      TBC

    • getAssetDbtSemanticLayerProxyUrl

      String getAssetDbtSemanticLayerProxyUrl()
      TBC

    • getAssetDbtSourceFreshnessCriteria

      String getAssetDbtSourceFreshnessCriteria()
      TBC

    • getAssetDbtTags

      SortedSet<String> getAssetDbtTags()
      TBC

    • getAssetDbtTestStatus

      String getAssetDbtTestStatus()
      TBC

    • getAssetDbtUniqueId

      String getAssetDbtUniqueId()
      TBC

    • getAssetDbtWorkflowLastUpdated

      String getAssetDbtWorkflowLastUpdated()
      TBC

    • getAssetIcon

      AtlanIcon getAssetIcon()
      TBC

    • getAssetMcAlertQualifiedNames

      SortedSet<String> getAssetMcAlertQualifiedNames()
      TBC

    • getAssetMcIncidentNames

      SortedSet<String> getAssetMcIncidentNames()
      TBC

    • getAssetMcIncidentPriorities

      SortedSet<String> getAssetMcIncidentPriorities()
      TBC

    • getAssetMcIncidentQualifiedNames

      SortedSet<String> getAssetMcIncidentQualifiedNames()
      TBC

    • getAssetMcIncidentSeverities

      SortedSet<String> getAssetMcIncidentSeverities()
      TBC

    • getAssetMcIncidentStates

      SortedSet<String> getAssetMcIncidentStates()
      TBC

    • getAssetMcIncidentSubTypes

      SortedSet<String> getAssetMcIncidentSubTypes()
      TBC

    • getAssetMcIncidentTypes

      SortedSet<String> getAssetMcIncidentTypes()
      TBC

    • getAssetMcLastSyncRunAt

      Long getAssetMcLastSyncRunAt()
      TBC

    • getAssetMcMonitorNames

      SortedSet<String> getAssetMcMonitorNames()
      TBC

    • getAssetMcMonitorQualifiedNames

      SortedSet<String> getAssetMcMonitorQualifiedNames()
      TBC

    • getAssetMcMonitorScheduleTypes

      SortedSet<String> getAssetMcMonitorScheduleTypes()
      TBC

    • getAssetMcMonitorStatuses

      SortedSet<String> getAssetMcMonitorStatuses()
      TBC

    • getAssetMcMonitorTypes

      SortedSet<String> getAssetMcMonitorTypes()
      TBC

    • getAssetPoliciesCount

      Long getAssetPoliciesCount()
      TBC

    • getAssetPolicyGUIDs

      SortedSet<String> getAssetPolicyGUIDs()
      TBC

    • getAssetSodaCheckCount

      Long getAssetSodaCheckCount()
      TBC

    • getAssetSodaCheckStatuses

      String getAssetSodaCheckStatuses()
      TBC

    • getAssetSodaDQStatus

      String getAssetSodaDQStatus()
      TBC

    • getAssetSodaLastScanAt

      Long getAssetSodaLastScanAt()
      TBC

    • getAssetSodaLastSyncRunAt

      Long getAssetSodaLastSyncRunAt()
      TBC

    • getAssetSodaSourceURL

      String getAssetSodaSourceURL()
      TBC

    • getAssetTags

      SortedSet<String> getAssetTags()
      TBC

    • getAssetThemeHex

      String getAssetThemeHex()
      TBC

    • getAssignedEntities

      SortedSet<IAsset> getAssignedEntities()
      TBC

    • getAssignedTerms

      SortedSet<IGlossaryTerm> getAssignedTerms()
      TBC

    • getCategories

      SortedSet<IGlossaryCategory> getCategories()
      TBC

    • getCertificateStatus

      CertificateStatus getCertificateStatus()
      TBC

    • getCertificateStatusMessage

      String getCertificateStatusMessage()
      TBC

    • getCertificateUpdatedAt

      Long getCertificateUpdatedAt()
      TBC

    • getCertificateUpdatedBy

      String getCertificateUpdatedBy()
      TBC

    • getClassifies

      SortedSet<IGlossaryTerm> getClassifies()
      TBC

    • getConnectionName

      String getConnectionName()
      TBC

    • getConnectionQualifiedName

      String getConnectionQualifiedName()
      TBC

    • getConnectorType

      AtlanConnectorType getConnectorType()
      TBC

    • getDataContractLatest

      IDataContract getDataContractLatest()
      TBC

    • getDataContractLatestCertified

      IDataContract getDataContractLatestCertified()
      TBC

    • getDbtQualifiedName

      String getDbtQualifiedName()
      TBC

    • getDescription

      String getDescription()
      TBC

    • getDisplayName

      String getDisplayName()
      TBC

    • getDomainGUIDs

      SortedSet<String> getDomainGUIDs()
      TBC

    • getExamples

      SortedSet<String> getExamples()
      TBC

    • getFiles

      SortedSet<IFile> getFiles()
      TBC

    • getHasContract

      Boolean getHasContract()
      TBC

    • getHasLineage

      Boolean getHasLineage()
      TBC

    • getInputPortDataProducts

      SortedSet<IDataProduct> getInputPortDataProducts()
      TBC

    • getIsA

      SortedSet<IGlossaryTerm> getIsA()
      TBC

    • getIsAIGenerated

      Boolean getIsAIGenerated()
      TBC

    • getIsDiscoverable

      Boolean getIsDiscoverable()
      TBC

    • getIsEditable

      Boolean getIsEditable()
      TBC

    • getIsPartial

      Boolean getIsPartial()
      TBC

    • getLastRowChangedAt

      Long getLastRowChangedAt()
      TBC

    • getLastSyncRun

      String getLastSyncRun()
      TBC

    • getLastSyncRunAt

      Long getLastSyncRunAt()
      TBC

    • getLastSyncWorkflowName

      String getLastSyncWorkflowName()
      TBC

    • getLexicographicalSortOrder

      String getLexicographicalSortOrder()
      TBC

    • getLinks

      SortedSet<ILink> getLinks()
      TBC

    • getLongDescription

      String getLongDescription()
      TBC

    • getMcIncidents

      SortedSet<IMCIncident> getMcIncidents()
      TBC

    • getMcMonitors

      SortedSet<IMCMonitor> getMcMonitors()
      TBC

    • getMetrics

      SortedSet<IMetric> getMetrics()
      TBC

    • getName

      String getName()
      TBC

    • getNonCompliantAssetPolicyGUIDs

      SortedSet<String> getNonCompliantAssetPolicyGUIDs()
      TBC

    • getOutputPortDataProducts

      SortedSet<IDataProduct> getOutputPortDataProducts()
      TBC

    • getOwnerGroups

      SortedSet<String> getOwnerGroups()
      TBC

    • getOwnerUsers

      SortedSet<String> getOwnerUsers()
      TBC

    • getPopularityScore

      Double getPopularityScore()
      TBC

    • getPreferredTerms

      SortedSet<IGlossaryTerm> getPreferredTerms()
      TBC

    • getPreferredToTerms

      SortedSet<IGlossaryTerm> getPreferredToTerms()
      TBC

    • getQualifiedName

      String getQualifiedName()
      TBC

    • getReadme

      IReadme getReadme()
      TBC

    • getReplacedBy

      SortedSet<IGlossaryTerm> getReplacedBy()
      TBC

    • getReplacementTerms

      SortedSet<IGlossaryTerm> getReplacementTerms()
      TBC

    • getSampleDataUrl

      String getSampleDataUrl()
      TBC

    • getSchemaRegistrySubjects

      SortedSet<ISchemaRegistrySubject> getSchemaRegistrySubjects()
      TBC

    • getSeeAlso

      SortedSet<IGlossaryTerm> getSeeAlso()
      TBC

    • getShortDescription

      String getShortDescription()
      TBC

    • getSodaChecks

      SortedSet<ISodaCheck> getSodaChecks()
      TBC

    • getSourceCostUnit

      SourceCostUnitType getSourceCostUnit()
      TBC

    • getSourceCreatedAt

      Long getSourceCreatedAt()
      TBC

    • getSourceCreatedBy

      String getSourceCreatedBy()
      TBC

    • getSourceEmbedURL

      String getSourceEmbedURL()
      TBC

    • getSourceLastReadAt

      Long getSourceLastReadAt()
      TBC

    • getSourceOwners

      String getSourceOwners()
      TBC

    • getSourceQueryComputeCostRecords

      List<PopularityInsights> getSourceQueryComputeCostRecords()
      TBC

    • getSourceQueryComputeCosts

      SortedSet<String> getSourceQueryComputeCosts()
      TBC

    • getSourceReadCount

      Long getSourceReadCount()
      TBC

    • getSourceReadExpensiveQueryRecords

      List<PopularityInsights> getSourceReadExpensiveQueryRecords()
      TBC

    • getSourceReadPopularQueryRecords

      List<PopularityInsights> getSourceReadPopularQueryRecords()
      TBC

    • getSourceReadQueryCost

      Double getSourceReadQueryCost()
      TBC

    • getSourceReadRecentUserRecords

      List<PopularityInsights> getSourceReadRecentUserRecords()
      TBC

    • getSourceReadRecentUsers

      SortedSet<String> getSourceReadRecentUsers()
      TBC

    • getSourceReadSlowQueryRecords

      List<PopularityInsights> getSourceReadSlowQueryRecords()
      TBC

    • getSourceReadTopUserRecords

      List<PopularityInsights> getSourceReadTopUserRecords()
      TBC

    • getSourceReadTopUsers

      SortedSet<String> getSourceReadTopUsers()
      TBC

    • getSourceReadUserCount

      Long getSourceReadUserCount()
      TBC

    • getSourceTotalCost

      Double getSourceTotalCost()
      TBC

    • getSourceURL

      String getSourceURL()
      TBC

    • getSourceUpdatedAt

      Long getSourceUpdatedAt()
      TBC

    • getSourceUpdatedBy

      String getSourceUpdatedBy()
      TBC

    • getStarredBy

      SortedSet<String> getStarredBy()
      TBC

    • getStarredCount

      Integer getStarredCount()
      TBC

    • getStarredDetails

      List<StarredDetails> getStarredDetails()
      TBC

    • getSubType

      String getSubType()
      TBC

    • getSynonyms

      SortedSet<IGlossaryTerm> getSynonyms()
      TBC

    • getTenantId

      String getTenantId()
      TBC

    • getTermType

      AtlasGlossaryTermType getTermType()
      TBC

    • getTranslatedTerms

      SortedSet<IGlossaryTerm> getTranslatedTerms()
      TBC

    • getTranslationTerms

      SortedSet<IGlossaryTerm> getTranslationTerms()
      TBC

    • getUsage

      String getUsage()
      TBC

    • getUserDefRelationshipFroms

      SortedSet<IAsset> getUserDefRelationshipFroms()
      TBC

    • getUserDefRelationshipTos

      SortedSet<IAsset> getUserDefRelationshipTos()
      TBC

    • getUserDescription

      String getUserDescription()
      TBC

    • getValidValues

      SortedSet<IGlossaryTerm> getValidValues()
      TBC

    • getValidValuesFor

      SortedSet<IGlossaryTerm> getValidValuesFor()
      TBC

    • getViewScore

      Double getViewScore()
      TBC

    • getViewerGroups

      SortedSet<String> getViewerGroups()
      TBC

    • getViewerUsers

      SortedSet<String> getViewerUsers()
      TBC

    • getTypeName

      String getTypeName()
      Name of the type that defines the asset.

    • getGuid

      String getGuid()
      Globally-unique identifier for the asset.

    • getDisplayText

      String getDisplayText()
      Human-readable name of the asset.

    • getEntityStatus

      String getEntityStatus()
      Status of the asset (if this is a related asset).

    • getRelationshipType

      String getRelationshipType()
      Type of the relationship (if this is a related asset).

    • getRelationshipGuid

      String getRelationshipGuid()
      Unique identifier of the relationship (when this is a related asset).

    • getRelationshipStatus

      AtlanStatus getRelationshipStatus()
      Status of the relationship (when this is a related asset).

    • getRelationshipAttributes

      RelationshipAttributes getRelationshipAttributes()
      Attributes specific to the relationship (unused).

    • getUniqueAttributes

      UniqueAttributes getUniqueAttributes()
      Attribute(s) that uniquely identify the asset (when this is a related asset). If the guid is not provided, these must be provided.

    • isComplete

      boolean isComplete()
      When true, indicates that this object represents a complete view of the entity. When false, this object is only a reference or some partial view of the entity.

    • isValidReferenceByGuid

      boolean isValidReferenceByGuid()
      Indicates whether this object can be used as a valid reference by GUID.
      Returns:
      true if it is a valid GUID reference, false otherwise

    • isValidReferenceByQualifiedName

      boolean isValidReferenceByQualifiedName()
      Indicates whether this object can be used as a valid reference by qualifiedName.
      Returns:
      true if it is a valid qualifiedName reference, false otherwise