Package com.atlan.model.assets

Class GlossaryCategory

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.GlossaryCategory
All Implemented Interfaces:
IAsset, IGlossaryCategory, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
Direct Known Subclasses:
GlossaryTermCategorization.Category
@Generated("com.atlan.generators.ModelGeneratorV2") public class GlossaryCategory extends Asset implements IGlossaryCategory, IAsset, IReferenceable
Instance of a category in Atlan, an organizational construct for glossary terms.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • creator

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

    • creator

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

    • updater

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

    • trimToRequired

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

    • findByName

      public static List<GlossaryCategory> findByName(String name, String glossaryName) throws AtlanException
      Find a GlossaryCategory by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the category, 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. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      name - of the GlossaryCategory
      glossaryName - name of the Glossary in which the category exists
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByName

      public static List<GlossaryCategory> findByName(String name, String glossaryName, Collection<String> attributes) throws AtlanException
      Find a GlossaryCategory 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. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      name - of the GlossaryCategory
      glossaryName - name of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryCategory
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByName

      public static List<GlossaryCategory> findByName(String name, String glossaryName, List<AtlanField> attributes) throws AtlanException
      Find a GlossaryCategory 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. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      name - of the GlossaryCategory
      glossaryName - name of the Glossary in which the category exists
      attributes - an optional collection of attributes (checked) to retrieve for the GlossaryCategory
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByName

      public static List<GlossaryCategory> findByName(AtlanClient client, String name, String glossaryName) throws AtlanException
      Find a GlossaryCategory by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the category, 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 on which to search for the GlossaryCategory
      name - of the GlossaryCategory
      glossaryName - name of the Glossary in which the category exists
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByName

      public static List<GlossaryCategory> findByName(AtlanClient client, String name, String glossaryName, Collection<String> attributes) throws AtlanException
      Find a GlossaryCategory 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. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      client - connectivity to the Atlan tenant on which to search for the GlossaryCategory
      name - of the GlossaryCategory
      glossaryName - name of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryCategory
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByName

      public static List<GlossaryCategory> findByName(AtlanClient client, String name, String glossaryName, List<AtlanField> attributes) throws AtlanException
      Find a GlossaryCategory 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. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      client - connectivity to the Atlan tenant on which to search for the GlossaryCategory
      name - of the GlossaryCategory
      glossaryName - name of the Glossary in which the category exists
      attributes - an optional collection of attributes (checked) to retrieve for the GlossaryCategory
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByNameFast

      public static List<GlossaryCategory> findByNameFast(String name, String glossaryQualifiedName) throws AtlanException
      Find a GlossaryCategory by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the category, if found. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      name - of the GlossaryCategory
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByNameFast

      public static List<GlossaryCategory> findByNameFast(String name, String glossaryQualifiedName, Collection<String> attributes) throws AtlanException
      Find a GlossaryCategory by its human-readable name. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      name - of the GlossaryCategory
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      attributes - an optional collection of attributes (unchecked) to retrieve for the GlossaryCategory
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByNameFast

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

    • findByNameFast

      public static List<GlossaryCategory> findByNameFast(AtlanClient client, String name, String glossaryQualifiedName) throws AtlanException
      Find a GlossaryCategory by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the category, if found. Note that categories are not unique by name, so there may be multiple results.
      Parameters:
      client - connectivity to the Atlan tenant on which to search for the GlossaryCategory
      name - of the GlossaryCategory
      glossaryQualifiedName - qualifiedName of the Glossary in which the category exists
      Returns:
      the GlossaryCategory, if found
      Throws:
      AtlanException - on any API problems, or if the GlossaryCategory does not exist

    • findByNameFast

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

    • findByNameFast

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • removeAnnouncement

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static GlossaryCategory.GlossaryCategoryBuilder<?,?> _internal()

    • toBuilder

      public GlossaryCategory.GlossaryCategoryBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAdditionalAttributes

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

    • getAnchor

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

    • getCategoryType

      public AtlasGlossaryCategoryType getCategoryType()
      TBC
      Specified by:
      getCategoryType in interface IGlossaryCategory

    • getChildrenCategories

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

    • getLongDescription

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

    • getParentCategory

      public IGlossaryCategory getParentCategory()
      TBC
      Specified by:
      getParentCategory in interface IGlossaryCategory

    • getShortDescription

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

    • getTerms

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

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