Class Artifact

All Implemented Interfaces:
IAgentic, IArtifact, IAsset, ICatalog, IReferenceable, IResource, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class Artifact extends Asset implements IArtifact, IAgentic, IResource, ICatalog, IAsset, IReferenceable
Base class for artifacts in Atlan. An artifact is a file or data object associated with an agentic asset. Extends File for native fileType and filePath support.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

      public static Artifact get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a Artifact 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 Artifact to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the Artifact, including any relationships
      Returns:
      the requested Artifact, 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 Artifact does not exist or the provided GUID is not a Artifact
    • get

      public static Artifact get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a Artifact 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 Artifact to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the Artifact, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the Artifact
      Returns:
      the requested Artifact, 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 Artifact does not exist or the provided GUID is not a Artifact
    • restore

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static Artifact.ArtifactBuilder<?,?> _internal()
    • toBuilder

      public Artifact.ArtifactBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getArtifactVersion

      public String getArtifactVersion()
      Version identifier for this artifact.
      Specified by:
      getArtifactVersion in interface IArtifact
    • getCatalogDatasetGuid

      public String getCatalogDatasetGuid()
      Unique identifier of the dataset this asset belongs to.
      Specified by:
      getCatalogDatasetGuid in interface IAgentic
      Specified by:
      getCatalogDatasetGuid in interface IArtifact
      Specified by:
      getCatalogDatasetGuid in interface ICatalog
      Specified by:
      getCatalogDatasetGuid in interface IResource
    • getFilePath

      public String getFilePath()
      URL giving the online location where the file can be accessed.
      Specified by:
      getFilePath in interface IArtifact
    • getFileType

      public FileType getFileType()
      Type (extension) of the file.
      Specified by:
      getFileType in interface IArtifact
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface IAgentic
      Specified by:
      getInputToAirflowTasks in interface IArtifact
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IResource
    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface IAgentic
      Specified by:
      getInputToProcesses in interface IArtifact
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IResource
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IAgentic
      Specified by:
      getInputToSparkJobs in interface IArtifact
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IResource
    • getIsGlobal

      public Boolean getIsGlobal()
      Whether the resource is global (true) or not (false).
      Specified by:
      getIsGlobal in interface IArtifact
      Specified by:
      getIsGlobal in interface IResource
    • getLink

      public String getLink()
      URL to the resource.
      Specified by:
      getLink in interface IArtifact
      Specified by:
      getLink in interface IResource
    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface IAgentic
      Specified by:
      getModelImplementedAttributes in interface IArtifact
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface IResource
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface IAgentic
      Specified by:
      getModelImplementedEntities in interface IArtifact
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IResource
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface IAgentic
      Specified by:
      getOutputFromAirflowTasks in interface IArtifact
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IResource
    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface IAgentic
      Specified by:
      getOutputFromProcesses in interface IArtifact
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface IResource
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAgentic
      Specified by:
      getOutputFromSparkJobs in interface IArtifact
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IResource
    • getPartialChildFields

      public SortedSet<IPartialField> getPartialChildFields()
      Partial fields contained in the asset.
      Specified by:
      getPartialChildFields in interface IAgentic
      Specified by:
      getPartialChildFields in interface IArtifact
      Specified by:
      getPartialChildFields in interface ICatalog
      Specified by:
      getPartialChildFields in interface IResource
    • getPartialChildObjects

      public SortedSet<IPartialObject> getPartialChildObjects()
      Partial objects contained in the asset.
      Specified by:
      getPartialChildObjects in interface IAgentic
      Specified by:
      getPartialChildObjects in interface IArtifact
      Specified by:
      getPartialChildObjects in interface ICatalog
      Specified by:
      getPartialChildObjects in interface IResource
    • getReference

      public String getReference()
      Reference to the resource.
      Specified by:
      getReference in interface IArtifact
      Specified by:
      getReference in interface IResource
    • getResourceMetadata

      public Map<String,String> getResourceMetadata()
      Metadata of the resource.
      Specified by:
      getResourceMetadata in interface IArtifact
      Specified by:
      getResourceMetadata in interface IResource
    • 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 Artifacts.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAgentic
      Specified by:
      getTypeName in interface IArtifact
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface IResource
      Overrides:
      getTypeName in class Reference