Package com.atlan.model.assets

Class Glossary

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Glossary
All Implemented Interfaces:
IAsset, IGlossary, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class Glossary extends Asset implements IGlossary, IAsset, IReferenceable
Instance of a glossary in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all Glossary 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) Glossary assets will be included.
      Returns:
      a fluent search that includes all Glossary assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all Glossary 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) Glossary assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all Glossary assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all Glossary 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) Glossarys will be included
      Returns:
      a fluent search that includes all Glossary assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all Glossary 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) Glossarys will be included
      Returns:
      a fluent search that includes all Glossary assets

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

      public static Glossary get(AtlanClient client, String id) throws AtlanException
      Retrieves a Glossary 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 Glossary to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full Glossary, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Glossary does not exist or the provided GUID is not a Glossary

    • get

      public static Glossary get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a Glossary 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 Glossary 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 Glossary, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Glossary does not exist or the provided GUID is not a Glossary

    • restore

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

    • creator

      public static Glossary.GlossaryBuilder<?,?> creator(String name)
      Builds the minimal object necessary for creating a Glossary.
      Parameters:
      name - of the Glossary
      Returns:
      the minimal object necessary to create the Glossary, as a builder

    • updater

      public static Glossary.GlossaryBuilder<?,?> updater(String guid, String name)
      Builds the minimal object necessary to update a Glossary.
      Parameters:
      guid - unique identifier of the Glossary
      name - of the Glossary
      Returns:
      the minimal object necessary to update the Glossary, as a builder

    • trimToRequired

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

    • findByName

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

    • findByName

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

    • findByName

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

    • findByName

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

    • findByName

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

    • findByName

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

    • getAllQualifiedNames

      public static List<String> getAllQualifiedNames() throws AtlanException
      Retrieve the qualifiedNames of all glossaries that exist in Atlan.
      Returns:
      list of all glossary qualifiedNames
      Throws:
      AtlanException - on any API problems

    • getAllQualifiedNames

      public static List<String> getAllQualifiedNames(AtlanClient client) throws AtlanException
      Retrieve the qualifiedNames of all glossaries that exist in Atlan.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the qualifiedNames
      Returns:
      list of all glossary qualifiedNames
      Throws:
      AtlanException - on any API problems

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy() throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects.
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(AtlanClient client) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(Collection<String> attributes) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects. Note: by default, each category will have a minimal set of information (name, GUID, qualifiedName). If you want additional details about each category, specify the attributes you want in the attributes parameter to this method.
      Parameters:
      attributes - (unchecked) to retrieve for each category in the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(List<AtlanField> attributes) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects. Note: by default, each category will have a minimal set of information (name, GUID, qualifiedName). If you want additional details about each category, specify the attributes you want in the attributes parameter to this method.
      Parameters:
      attributes - (checked) to retrieve for each category in the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(List<AtlanField> attributes, List<AtlanField> relatedAttributes) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects. Note: by default, each category will have a minimal set of information (name, GUID, qualifiedName). If you want additional details about each category, specify the attributes you want in the attributes parameter to this method.
      Parameters:
      attributes - (checked) to retrieve for each category in the hierarchy
      relatedAttributes - (checked) to retrieve for each relationship attribute retrieved for each category in the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(AtlanClient client, Collection<String> attributes) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects. Note: by default, each category will have a minimal set of information (name, GUID, qualifiedName). If you want additional details about each category, specify the attributes you want in the attributes parameter to this method.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the hierarchy
      attributes - (unchecked) to retrieve for each category in the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(AtlanClient client, List<AtlanField> attributes) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects. Note: by default, each category will have a minimal set of information (name, GUID, qualifiedName). If you want additional details about each category, specify the attributes you want in the attributes parameter to this method.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the hierarchy
      attributes - (checked) to retrieve for each category in the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • getHierarchy

      public Glossary.CategoryHierarchy getHierarchy(AtlanClient client, List<AtlanField> attributes, List<AtlanField> relatedAttributes) throws AtlanException
      Retrieve category hierarchy in this Glossary, in a traversable form. You can traverse in either depth-first (Glossary.CategoryHierarchy.depthFirst()) or breadth-first (Glossary.CategoryHierarchy.breadthFirst()) order. Both return an ordered list of GlossaryCategory objects. Note: by default, each category will have a minimal set of information (name, GUID, qualifiedName). If you want additional details about each category, specify the attributes you want in the attributes parameter to this method.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the hierarchy
      attributes - (checked) to retrieve for each category in the hierarchy
      relatedAttributes - (checked) to retrieve for each relationship attribute retrieved for each category in the hierarchy
      Returns:
      a traversable category hierarchy
      Throws:
      AtlanException - on any API problems, or if the Glossary does not exist

    • removeDescription

      public static Glossary removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a Glossary.
      Parameters:
      qualifiedName - of the Glossary
      name - of the Glossary
      Returns:
      the updated Glossary, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

      public static Glossary removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a Glossary.
      Parameters:
      qualifiedName - of the Glossary
      name - of the Glossary
      Returns:
      the updated Glossary, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

      public static Glossary removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a Glossary.
      Parameters:
      qualifiedName - of the Glossary
      name - of the Glossary
      Returns:
      the updated Glossary, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

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

    • updateAnnouncement

      public static Glossary updateAnnouncement(String qualifiedName, String name, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Glossary.
      Parameters:
      qualifiedName - of the Glossary
      name - of the 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 result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static Glossary updateAnnouncement(AtlanClient client, String qualifiedName, String name, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Glossary.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the Glossary's announcement
      qualifiedName - of the Glossary
      name - of the 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 result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static Glossary removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a Glossary.
      Parameters:
      qualifiedName - of the Glossary
      name - of the Glossary
      Returns:
      the updated Glossary, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

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

    • appendAtlanTags

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

    • appendAtlanTags

      public static Glossary appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a Glossary, without replacing existing Atlan tags linked to the Glossary. Note: this operation must make two API calls — one to retrieve the Glossary'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 Glossary
      qualifiedName - of the Glossary
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated Glossary
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Glossary appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Glossary, without replacing existing Atlan tags linked to the Glossary. Note: this operation must make two API calls — one to retrieve the Glossary's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the Glossary
      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 Glossary
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static Glossary appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Glossary, without replacing existing Atlan tags linked to the Glossary. Note: this operation must make two API calls — one to retrieve the Glossary'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 Glossary
      qualifiedName - of the Glossary
      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 Glossary
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Glossary.
      Parameters:
      qualifiedName - of the Glossary
      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 Glossary

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Glossary.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a Glossary
      qualifiedName - of the Glossary
      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 Glossary

    • _internal

      public static Glossary.GlossaryBuilder<?,?> _internal()

    • toBuilder

      public Glossary.GlossaryBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAdditionalAttributes

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

    • getCategories

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

    • getGlossaryType

      public AtlasGlossaryType getGlossaryType()
      TBC
      Specified by:
      getGlossaryType in interface IGlossary

    • getLanguage

      public String getLanguage()
      TBC
      Specified by:
      getLanguage in interface IGlossary

    • getLongDescription

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

    • getShortDescription

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

    • getTerms

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

    • getUsage

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

    • 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 Glossarys.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IGlossary
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference