Package com.atlan.model.assets

Class GlossaryTerm

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.GlossaryTerm
All Implemented Interfaces:
IAsset, IGlossaryTerm, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
Direct Known Subclasses:
GlossaryAntonym.Antonym, GlossaryIsA.Classify, GlossaryIsA.IsA, GlossaryPreferredTerm.PreferredTerm, GlossaryPreferredTerm.PreferredToTerm, GlossaryRelatedTerm.SeeAlso, GlossaryReplacementTerm.ReplacedBy, GlossaryReplacementTerm.ReplacementTerm, GlossarySemanticAssignment.AssignedTerm, GlossarySynonym.Synonym, GlossaryTermCategorization.Term, GlossaryTranslation.TranslatedTerm, GlossaryTranslation.TranslationTerm, GlossaryValidValue.ValidValue, GlossaryValidValue.ValidValuesFor
@Generated("com.atlan.generators.ModelGeneratorV2") public class GlossaryTerm extends Asset implements IGlossaryTerm, IAsset, IReferenceable
Instance of a term in Atlan. Terms define concepts in natural language that can be associated with other assets to provide meaning.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public GlossaryTerm trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a GlossaryTerm, from a potentially more-complete GlossaryTerm object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the GlossaryTerm
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a GlossaryTerm relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all GlossaryTerm assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) GlossaryTerm assets will be included.
      Returns:
      a fluent search that includes all GlossaryTerm assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all GlossaryTerm assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) GlossaryTerm assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all GlossaryTerm assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all GlossaryTerm assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) GlossaryTerms will be included
      Returns:
      a fluent search that includes all GlossaryTerm assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all GlossaryTerm assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) GlossaryTerms will be included
      Returns:
      a fluent search that includes all GlossaryTerm assets

    • refByGuid

      public static GlossaryTerm refByGuid(String guid)
      Reference to a GlossaryTerm by GUID. Use this to create a relationship to this GlossaryTerm, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the GlossaryTerm to reference
      Returns:
      reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm

    • refByGuid

      public static GlossaryTerm refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a GlossaryTerm by GUID. Use this to create a relationship to this GlossaryTerm, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the GlossaryTerm to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm

    • refByQualifiedName

      public static GlossaryTerm refByQualifiedName(String qualifiedName)
      Reference to a GlossaryTerm by qualifiedName. Use this to create a relationship to this GlossaryTerm, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the GlossaryTerm to reference
      Returns:
      reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm

    • refByQualifiedName

      public static GlossaryTerm refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a GlossaryTerm by qualifiedName. Use this to create a relationship to this GlossaryTerm, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the GlossaryTerm to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a GlossaryTerm that can be used for defining a relationship to a GlossaryTerm

    • get

      public static GlossaryTerm get(String id) throws AtlanException
      Retrieves a GlossaryTerm by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the GlossaryTerm to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full GlossaryTerm, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm

    • get

      public static GlossaryTerm get(AtlanClient client, String id) throws AtlanException
      Retrieves a GlossaryTerm by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the GlossaryTerm to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full GlossaryTerm, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm

    • get

      public static GlossaryTerm get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a GlossaryTerm by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the GlossaryTerm to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full GlossaryTerm, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the GlossaryTerm does not exist or the provided GUID is not a GlossaryTerm

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) GlossaryTerm to active.
      Parameters:
      qualifiedName - for the GlossaryTerm
      Returns:
      true if the GlossaryTerm is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) GlossaryTerm to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the GlossaryTerm
      Returns:
      true if the GlossaryTerm is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • creator

      public static GlossaryTerm.GlossaryTermBuilder<?,?> creator(String name, Glossary glossary) throws InvalidRequestException
      Builds the minimal object necessary for creating a term.
      Parameters:
      name - of the term
      glossary - in which the term should be created
      Returns:
      the minimal request necessary to create the term, as a builder
      Throws:
      InvalidRequestException - if the glossary provided is without a GUID or qualifiedName

    • creator

      public static GlossaryTerm.GlossaryTermBuilder<?,?> creator(String name, String glossaryId)
      Builds the minimal object necessary for creating a term.
      Parameters:
      name - of the term
      glossaryId - unique identifier of the term's glossary, either is real GUID or qualifiedName
      Returns:
      the minimal request necessary to create the term, as a builder

    • updater

      public static GlossaryTerm.GlossaryTermBuilder<?,?> updater(String qualifiedName, String name, String glossaryGuid)
      Builds the minimal object necessary to update a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique identifier of the GlossaryTerm's glossary
      Returns:
      the minimal request necessary to update the GlossaryTerm, as a builder

    • trimToRequired

      public GlossaryTerm.GlossaryTermBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a GlossaryTerm, from a potentially more-complete GlossaryTerm object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the GlossaryTerm, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for GlossaryTerm are not found in the initial object

    • findByName

      public static GlossaryTerm findByName(String name, String glossaryName) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the term, if found. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.
      Parameters:
      name - of the GlossaryTerm
      glossaryName - human-readable name of the Glossary in which the category exists
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByName

      public static GlossaryTerm findByName(String name, String glossaryName, Collection<String> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.
      Parameters:
      name - of the GlossaryTerm
      glossaryName - human-readable name of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByName

      public static GlossaryTerm findByName(String name, String glossaryName, List<AtlanField> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.
      Parameters:
      name - of the GlossaryTerm
      glossaryName - human-readable name of the Glossary in which the category exists
      attributes - an optional collection of attributes (checked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByName

      public static GlossaryTerm findByName(AtlanClient client, String name, String glossaryName) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the term, if found. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the GlossaryTerm
      name - of the GlossaryTerm
      glossaryName - human-readable name of the Glossary in which the category exists
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByName

      public static GlossaryTerm findByName(AtlanClient client, String name, String glossaryName, Collection<String> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the GlossaryTerm
      name - of the GlossaryTerm
      glossaryName - human-readable name of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByName

      public static GlossaryTerm findByName(AtlanClient client, String name, String glossaryName, List<AtlanField> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Note that this operation must run two separate queries to first resolve the qualifiedName of the glossary, so will be somewhat slower. If you already have the qualifiedName of the glossary, use findByNameFast instead.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the GlossaryTerm
      name - of the GlossaryTerm
      glossaryName - human-readable name of the Glossary in which the category exists
      attributes - an optional collection of attributes (checked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByNameFast

      public static GlossaryTerm findByNameFast(String name, String glossaryQualifiedName) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the term, if found.
      Parameters:
      name - of the GlossaryTerm
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByNameFast

      public static GlossaryTerm findByNameFast(String name, String glossaryQualifiedName, Collection<String> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name.
      Parameters:
      name - of the GlossaryTerm
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByNameFast

      public static GlossaryTerm findByNameFast(String name, String glossaryQualifiedName, List<AtlanField> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name.
      Parameters:
      name - of the GlossaryTerm
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      attributes - an optional collection of attributes (checked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByNameFast

      public static GlossaryTerm findByNameFast(AtlanClient client, String name, String glossaryQualifiedName) throws AtlanException
      Find a GlossaryTerm by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the term, if found.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the GlossaryTerm
      name - of the GlossaryTerm
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByNameFast

      public static GlossaryTerm findByNameFast(AtlanClient client, String name, String glossaryQualifiedName, Collection<String> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the GlossaryTerm
      name - of the GlossaryTerm
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • findByNameFast

      public static GlossaryTerm findByNameFast(AtlanClient client, String name, String glossaryQualifiedName, List<AtlanField> attributes) throws AtlanException
      Find a GlossaryTerm by its human-readable name.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the GlossaryTerm
      name - of the GlossaryTerm
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      attributes - an optional collection of attributes (checked) to retrieve for the GlossaryTerm
      Returns:
      the GlossaryTerm, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryTerm does not exist

    • removeDescription

      public static GlossaryTerm removeDescription(String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the system description from a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static GlossaryTerm removeDescription(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the system description from a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the GlossaryTerm's description
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static GlossaryTerm removeUserDescription(String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the user's description from a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static GlossaryTerm removeUserDescription(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the user's description from a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the GlossaryTerm's description
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static GlossaryTerm removeOwners(String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the owners from a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static GlossaryTerm removeOwners(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the owners from a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the GlossaryTerm's owners
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static GlossaryTerm updateCertificate(String qualifiedName, String name, String glossaryGuid, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated GlossaryTerm, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static GlossaryTerm updateCertificate(AtlanClient client, String qualifiedName, String name, String glossaryGuid, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the GlossaryTerm's certificate
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated GlossaryTerm, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static GlossaryTerm removeCertificate(String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the certificate from a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static GlossaryTerm removeCertificate(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the certificate from a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the GlossaryTerm's certificate
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static GlossaryTerm updateAnnouncement(String qualifiedName, String name, String glossaryGuid, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the updated GlossaryTerm, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static GlossaryTerm updateAnnouncement(AtlanClient client, String qualifiedName, String name, String glossaryGuid, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the GlossaryTerm's announcement
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the updated GlossaryTerm, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static GlossaryTerm removeAnnouncement(String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the announcement from a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static GlossaryTerm removeAnnouncement(AtlanClient client, String qualifiedName, String name, String glossaryGuid) throws AtlanException
      Remove the announcement from a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the GlossaryTerm's announcement
      qualifiedName - of the GlossaryTerm
      name - of the GlossaryTerm
      glossaryGuid - unique ID (GUID) of the GlossaryTerm's glossary
      Returns:
      the updated GlossaryTerm, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static GlossaryTerm appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a GlossaryTerm, without replacing existing Atlan tags linked to the GlossaryTerm. Note: this operation must make two API calls — one to retrieve the GlossaryTerm's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the GlossaryTerm
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated GlossaryTerm
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static GlossaryTerm appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a GlossaryTerm, without replacing existing Atlan tags linked to the GlossaryTerm. Note: this operation must make two API calls — one to retrieve the GlossaryTerm's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the GlossaryTerm
      qualifiedName - of the GlossaryTerm
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated GlossaryTerm
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static GlossaryTerm appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a GlossaryTerm, without replacing existing Atlan tags linked to the GlossaryTerm. Note: this operation must make two API calls — one to retrieve the GlossaryTerm's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the GlossaryTerm
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated GlossaryTerm
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static GlossaryTerm appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a GlossaryTerm, without replacing existing Atlan tags linked to the GlossaryTerm. Note: this operation must make two API calls — one to retrieve the GlossaryTerm's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the GlossaryTerm
      qualifiedName - of the GlossaryTerm
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated GlossaryTerm
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a GlossaryTerm.
      Parameters:
      qualifiedName - of the GlossaryTerm
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the GlossaryTerm

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a GlossaryTerm.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a GlossaryTerm
      qualifiedName - of the GlossaryTerm
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the GlossaryTerm

    • _internal

      public static GlossaryTerm.GlossaryTermBuilder<?,?> _internal()

    • toBuilder

      public GlossaryTerm.GlossaryTermBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAbbreviation

      public String getAbbreviation()
      TBC
      Specified by:
      getAbbreviation in interface IGlossaryTerm

    • getAdditionalAttributes

      public Map<String,String> getAdditionalAttributes()
      TBC
      Specified by:
      getAdditionalAttributes in interface IGlossaryTerm

    • getAnchor

      public IGlossary getAnchor()
      TBC
      Specified by:
      getAnchor in interface IGlossaryTerm

    • getAntonyms

      public SortedSet<IGlossaryTerm> getAntonyms()
      TBC
      Specified by:
      getAntonyms in interface IGlossaryTerm

    • getAssignedEntities

      public SortedSet<IAsset> getAssignedEntities()
      TBC
      Specified by:
      getAssignedEntities in interface IGlossaryTerm

    • getCategories

      public SortedSet<IGlossaryCategory> getCategories()
      TBC
      Specified by:
      getCategories in interface IGlossaryTerm

    • getClassifies

      public SortedSet<IGlossaryTerm> getClassifies()
      TBC
      Specified by:
      getClassifies in interface IGlossaryTerm

    • getExamples

      public SortedSet<String> getExamples()
      TBC
      Specified by:
      getExamples in interface IGlossaryTerm

    • getIsA

      public SortedSet<IGlossaryTerm> getIsA()
      TBC
      Specified by:
      getIsA in interface IGlossaryTerm

    • getLongDescription

      public String getLongDescription()
      TBC
      Specified by:
      getLongDescription in interface IGlossaryTerm

    • getPreferredTerms

      public SortedSet<IGlossaryTerm> getPreferredTerms()
      TBC
      Specified by:
      getPreferredTerms in interface IGlossaryTerm

    • getPreferredToTerms

      public SortedSet<IGlossaryTerm> getPreferredToTerms()
      TBC
      Specified by:
      getPreferredToTerms in interface IGlossaryTerm

    • getReplacedBy

      public SortedSet<IGlossaryTerm> getReplacedBy()
      TBC
      Specified by:
      getReplacedBy in interface IGlossaryTerm

    • getReplacementTerms

      public SortedSet<IGlossaryTerm> getReplacementTerms()
      TBC
      Specified by:
      getReplacementTerms in interface IGlossaryTerm

    • getSeeAlso

      public SortedSet<IGlossaryTerm> getSeeAlso()
      TBC
      Specified by:
      getSeeAlso in interface IGlossaryTerm

    • getShortDescription

      public String getShortDescription()
      TBC
      Specified by:
      getShortDescription in interface IGlossaryTerm

    • getSynonyms

      public SortedSet<IGlossaryTerm> getSynonyms()
      TBC
      Specified by:
      getSynonyms in interface IGlossaryTerm

    • getTermType

      public AtlasGlossaryTermType getTermType()
      TBC
      Specified by:
      getTermType in interface IGlossaryTerm

    • getTranslatedTerms

      public SortedSet<IGlossaryTerm> getTranslatedTerms()
      TBC
      Specified by:
      getTranslatedTerms in interface IGlossaryTerm

    • getTranslationTerms

      public SortedSet<IGlossaryTerm> getTranslationTerms()
      TBC
      Specified by:
      getTranslationTerms in interface IGlossaryTerm

    • getUsage

      public String getUsage()
      TBC
      Specified by:
      getUsage in interface IGlossaryTerm

    • getValidValues

      public SortedSet<IGlossaryTerm> getValidValues()
      TBC
      Specified by:
      getValidValues in interface IGlossaryTerm

    • getValidValuesFor

      public SortedSet<IGlossaryTerm> getValidValuesFor()
      TBC
      Specified by:
      getValidValuesFor in interface IGlossaryTerm

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset

    • getTypeName

      public String getTypeName()
      Fixed typeName for GlossaryTerms.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IGlossaryTerm
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference