Package com.atlan.model.assets

Class AtlanCollection

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • addApiTokenAsAdmin

      public AssetMutationResponse addApiTokenAsAdmin(String impersonationToken) throws AtlanException
      Add the API token configured for the default client as an admin for this AtlanCollection. This is necessary to allow the API token to manage the collection itself or any queries within it.
      Parameters:
      impersonationToken - a bearer token for an actual user who is already an admin for the AtlanCollection, NOT an API token
      Throws:
      AtlanException - on any error during API invocation

    • addApiTokenAsViewer

      public AssetMutationResponse addApiTokenAsViewer(String impersonationToken) throws AtlanException
      Add the API token configured for the default client as a viewer for this AtlanCollection. This is necessary to allow the API token to view or run queries within the collection, but not make any changes to them.
      Parameters:
      impersonationToken - a bearer token for an actual user who is already an admin for the AtlanCollection, NOT an API token
      Throws:
      AtlanException - on any error during API invocation

    • creator

      public static AtlanCollection.AtlanCollectionBuilder<?,?> creator(AtlanClient client, String name)
      Builds the minimal object necessary to create an AltanCollection.
      Parameters:
      client - connectivity to the Atlan tenant
      name - of the AtlanCollection as the user who will own the AtlanCollection
      Returns:
      the minimal request necessary to create the AtlanCollection, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(AtlanClient client)
      Generate a unique AltanCollection name.
      Parameters:
      client - connectivity to the Atlan tenant as the user who will own the AtlanCollection
      Returns:
      a unique name for the AltanCollection

    • save

      public AsyncCreationResponse save() throws AtlanException
      If an asset with the same qualifiedName exists, updates the existing asset. Otherwise, creates the asset. No Atlan tags or custom metadata will be changed if updating an existing asset, irrespective of what is included in the asset itself when the method is called.
      Overrides:
      save in class Asset
      Returns:
      details of the created or updated asset
      Throws:
      AtlanException - on any error during the API invocation

    • save

      public AsyncCreationResponse save(AtlanClient client) throws AtlanException
      If an asset with the same qualifiedName exists, updates the existing asset. Otherwise, creates the asset. No Atlan tags or custom metadata will be changed if updating an existing asset, irrespective of what is included in the asset itself when the method is called.
      Overrides:
      save in class Asset
      Parameters:
      client - connectivity to the Atlan tenant where this collection should be saved
      Returns:
      details of the created or updated asset
      Throws:
      AtlanException - on any error during the API invocation

    • save

      public AsyncCreationResponse save(boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() method. If an asset does exist, optionally overwrites any Atlan tags. Custom metadata will always be entirely ignored using this method.
      Overrides:
      save in class Asset
      Parameters:
      replaceAtlanTags - whether to replace Atlan tags during an update (true) or not (false)
      Returns:
      details of the created or updated asset
      Throws:
      AtlanException - on any error during the API invocation

    • save

      public AsyncCreationResponse save(AtlanClient client, boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() method. If an asset does exist, optionally overwrites any Atlan tags. Custom metadata will always be entirely ignored using this method.
      Overrides:
      save in class Asset
      Parameters:
      client - connectivity to the Atlan tenant where this collection should be saved
      replaceAtlanTags - whether to replace Atlan tags during an update (true) or not (false)
      Returns:
      details of the created or updated asset
      Throws:
      AtlanException - on any error during the API invocation

    • updater

      public static AtlanCollection.AtlanCollectionBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a AtlanCollection.
      Parameters:
      qualifiedName - of the AtlanCollection
      name - of the AtlanCollection
      Returns:
      the minimal request necessary to update the AtlanCollection, as a builder

    • trimToRequired

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

    • findByName

      public static List<AtlanCollection> findByName(String name) throws AtlanException
      Find a collection by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the collection, if found.
      Parameters:
      name - of the collection
      Returns:
      all collections with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the collection does not exist

    • findByName

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

    • findByName

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

    • findByName

      public static List<AtlanCollection> findByName(AtlanClient client, String name) throws AtlanException
      Find a collection by its human-readable name. Only the bare minimum set of attributes and no relationships will be retrieved for the collection, if found.
      Parameters:
      client - connectivity to the Atlan tenant in which to search for the collection
      name - of the collection
      Returns:
      all collections with that name, if found
      Throws:
      AtlanException - on any API problems
      NotFoundException - if the collection does not exist

    • findByName

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

    • findByName

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

      public static AtlanCollection replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the AtlanCollection.
      Parameters:
      qualifiedName - for the AtlanCollection
      name - human-readable name of the AtlanCollection
      terms - the list of terms to replace on the AtlanCollection, or null to remove all terms from the AtlanCollection
      Returns:
      the AtlanCollection that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static AtlanCollection replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the AtlanCollection.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the AtlanCollection's assigned terms
      qualifiedName - for the AtlanCollection
      name - human-readable name of the AtlanCollection
      terms - the list of terms to replace on the AtlanCollection, or null to remove all terms from the AtlanCollection
      Returns:
      the AtlanCollection that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static AtlanCollection appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the AtlanCollection, without replacing existing terms linked to the AtlanCollection. Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the AtlanCollection
      terms - the list of terms to append to the AtlanCollection
      Returns:
      the AtlanCollection that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static AtlanCollection appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the AtlanCollection, without replacing existing terms linked to the AtlanCollection. Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the AtlanCollection
      qualifiedName - for the AtlanCollection
      terms - the list of terms to append to the AtlanCollection
      Returns:
      the AtlanCollection that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static AtlanCollection removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a AtlanCollection, without replacing all existing terms linked to the AtlanCollection. Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the AtlanCollection
      terms - the list of terms to remove from the AtlanCollection, which must be referenced by GUID
      Returns:
      the AtlanCollection that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static AtlanCollection removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a AtlanCollection, without replacing all existing terms linked to the AtlanCollection. Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the AtlanCollection
      qualifiedName - for the AtlanCollection
      terms - the list of terms to remove from the AtlanCollection, which must be referenced by GUID
      Returns:
      the AtlanCollection that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static AtlanCollection.AtlanCollectionBuilder<?,?> _internal()

    • toBuilder

      public AtlanCollection.AtlanCollectionBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getChildrenFolders

      public SortedSet<IFolder> getChildrenFolders()
      TBC
      Specified by:
      getChildrenFolders in interface IAtlanCollection
      Specified by:
      getChildrenFolders in interface INamespace

    • getChildrenQueries

      public SortedSet<IAtlanQuery> getChildrenQueries()
      TBC
      Specified by:
      getChildrenQueries in interface IAtlanCollection
      Specified by:
      getChildrenQueries in interface INamespace

    • getIcon

      public String getIcon()
      TBC
      Specified by:
      getIcon in interface IAtlanCollection

    • getIconType

      public IconType getIconType()
      TBC
      Specified by:
      getIconType in interface IAtlanCollection

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