Package com.atlan.model.assets

Class SourceTag

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.SourceTag
All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISourceTag, ITag, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class SourceTag extends Asset implements ISourceTag, ITag, ICatalog, IAsset, IReferenceable
Instance of a source-system-imported tag in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

      public static SourceTag get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
      Retrieves a SourceTag 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 SourceTag to retrieve, either its GUID or its full qualifiedName
      includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full SourceTag, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SourceTag does not exist or the provided GUID is not a SourceTag

    • get

      public static SourceTag get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a SourceTag by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SourceTag to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SourceTag, including any relationships
      Returns:
      the requested SourceTag, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SourceTag does not exist or the provided GUID is not a SourceTag

    • get

      public static SourceTag get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a SourceTag by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SourceTag to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SourceTag, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the SourceTag
      Returns:
      the requested SourceTag, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SourceTag does not exist or the provided GUID is not a SourceTag

    • restore

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

    • creator

      public static SourceTag.SourceTagBuilder<?,?> creator(String name, String connectionQualifiedName, String mappedAtlanTagName, String sourceTagId, List<String> allowedValues)
      Builds the minimal object necessary to create a SourceTag.
      Parameters:
      name - of the SourceTag
      connectionQualifiedName - unique name of the connection in which to create the SourceTag
      mappedAtlanTagName - the human-readable name of the Atlan tag to which this SourceTag should map
      sourceTagId - unique identifier for the tag in the source
      allowedValues - the values allowed to be set for this tag in the source
      Returns:
      the minimal request necessary to create the SourceTag, as a builder

    • updater

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

    • generateQualifiedName

      public static String generateQualifiedName(String name, String connectionQualifiedName)
      Generate a unique SourceTag name.
      Parameters:
      name - of the SourceTag
      connectionQualifiedName - unique name of the schema in which this SourceTag exists
      Returns:
      a unique name for the SourceTag

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

      @Deprecated public static SourceTag appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
      Link additional terms to the SourceTag, without replacing existing terms linked to the SourceTag. Note: this operation must make two API calls — one to retrieve the SourceTag'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 SourceTag
      qualifiedName - for the SourceTag
      terms - the list of terms to append to the SourceTag
      Returns:
      the SourceTag that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      @Deprecated public static SourceTag removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
      Remove terms from a SourceTag, without replacing all existing terms linked to the SourceTag. Note: this operation must make two API calls — one to retrieve the SourceTag'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 SourceTag
      qualifiedName - for the SourceTag
      terms - the list of terms to remove from the SourceTag, which must be referenced by GUID
      Returns:
      the SourceTag that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • _internal

      public static SourceTag.SourceTagBuilder<?,?> _internal()

    • toBuilder

      public SourceTag.SourceTagBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getCustomConfiguration

      public String getCustomConfiguration()
      Specifies custom configuration elements based on the system the tag is being sourced from.
      Specified by:
      getCustomConfiguration in interface ISourceTag

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISourceTag
      Specified by:
      getInputToAirflowTasks in interface ITag

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISourceTag
      Specified by:
      getInputToProcesses in interface ITag

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISourceTag
      Specified by:
      getInputToSparkJobs in interface ITag

    • getMappedAtlanTagName

      public String getMappedAtlanTagName()
      Name of the classification in Atlan that is mapped to this tag.
      Specified by:
      getMappedAtlanTagName in interface ISourceTag
      Specified by:
      getMappedAtlanTagName in interface ITag

    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISourceTag
      Specified by:
      getModelImplementedAttributes in interface ITag

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISourceTag
      Specified by:
      getModelImplementedEntities in interface ITag

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISourceTag
      Specified by:
      getOutputFromAirflowTasks in interface ITag

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface ISourceTag
      Specified by:
      getOutputFromProcesses in interface ITag

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISourceTag
      Specified by:
      getOutputFromSparkJobs in interface ITag

    • getTagAllowedValues

      public SortedSet<String> getTagAllowedValues()
      Allowed values for the tag in the source system. These are denormalized from tagAttributes for ease of querying.
      Specified by:
      getTagAllowedValues in interface ISourceTag
      Specified by:
      getTagAllowedValues in interface ITag

    • getTagAttributes

      public List<SourceTagAttribute> getTagAttributes()
      Attributes associated with the tag in the source system.
      Specified by:
      getTagAttributes in interface ISourceTag
      Specified by:
      getTagAttributes in interface ITag

    • getTagId

      public String getTagId()
      Unique identifier of the tag in the source system.
      Specified by:
      getTagId in interface ISourceTag
      Specified by:
      getTagId in interface ITag

    • 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 SourceTags.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISourceTag
      Specified by:
      getTypeName in interface ITag
      Overrides:
      getTypeName in class Reference