Class AIModelVersion

All Implemented Interfaces:
IAI, IAIModelVersion, IAsset, ICatalog, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class AIModelVersion extends Asset implements IAIModelVersion, IAI, ICatalog, IAsset, IReferenceable
Base class for all AIModelVersion types.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      @Deprecated public static AIModelVersion appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a AIModelVersion, without replacing existing Atlan tags linked to the AIModelVersion. Note: this operation must make two API calls — one to retrieve the AIModelVersion'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 AIModelVersion
      qualifiedName - of the AIModelVersion
      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 AIModelVersion
      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 AIModelVersion.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a AIModelVersion
      qualifiedName - of the AIModelVersion
      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 AIModelVersion
    • _internal

      public static AIModelVersion.AIModelVersionBuilder<?,?> _internal()
    • toBuilder

      public AIModelVersion.AIModelVersionBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getAiModel

      public IAIModel getAiModel()
      Model containing the versions.
      Specified by:
      getAiModel in interface IAIModelVersion
    • getEthicalAIAccountabilityConfig

      public EthicalAIAccountabilityConfig getEthicalAIAccountabilityConfig()
      Accountability configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIAccountabilityConfig in interface IAI
      Specified by:
      getEthicalAIAccountabilityConfig in interface IAIModelVersion
    • getEthicalAIBiasMitigationConfig

      public EthicalAIBiasMitigationConfig getEthicalAIBiasMitigationConfig()
      Bias mitigation configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIBiasMitigationConfig in interface IAI
      Specified by:
      getEthicalAIBiasMitigationConfig in interface IAIModelVersion
    • getEthicalAIEnvironmentalConsciousnessConfig

      public EthicalAIEnvironmentalConsciousnessConfig getEthicalAIEnvironmentalConsciousnessConfig()
      Environmental consciousness configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIEnvironmentalConsciousnessConfig in interface IAI
      Specified by:
      getEthicalAIEnvironmentalConsciousnessConfig in interface IAIModelVersion
    • getEthicalAIFairnessConfig

      public EthicalAIFairnessConfig getEthicalAIFairnessConfig()
      Fairness configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIFairnessConfig in interface IAI
      Specified by:
      getEthicalAIFairnessConfig in interface IAIModelVersion
    • getEthicalAIPrivacyConfig

      public EthicalAIPrivacyConfig getEthicalAIPrivacyConfig()
      Privacy configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIPrivacyConfig in interface IAI
      Specified by:
      getEthicalAIPrivacyConfig in interface IAIModelVersion
    • getEthicalAIReliabilityAndSafetyConfig

      public EthicalAIReliabilityAndSafetyConfig getEthicalAIReliabilityAndSafetyConfig()
      Reliability and safety configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIReliabilityAndSafetyConfig in interface IAI
      Specified by:
      getEthicalAIReliabilityAndSafetyConfig in interface IAIModelVersion
    • getEthicalAITransparencyConfig

      public EthicalAITransparencyConfig getEthicalAITransparencyConfig()
      Transparency configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAITransparencyConfig in interface IAI
      Specified by:
      getEthicalAITransparencyConfig in interface IAIModelVersion
    • getInputToAirflowTasks

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

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

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IAI
      Specified by:
      getInputToSparkJobs in interface IAIModelVersion
      Specified by:
      getInputToSparkJobs in interface ICatalog
    • getModelImplementedAttributes

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

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

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

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

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAI
      Specified by:
      getOutputFromSparkJobs in interface IAIModelVersion
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
    • getPartialChildFields

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

      public SortedSet<IPartialObject> getPartialChildObjects()
      Partial objects contained in the asset.
      Specified by:
      getPartialChildObjects in interface IAI
      Specified by:
      getPartialChildObjects in interface IAIModelVersion
      Specified by:
      getPartialChildObjects in interface ICatalog
    • 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 AIModelVersions.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAI
      Specified by:
      getTypeName in interface IAIModelVersion
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference