Class ModelDataModel

All Implemented Interfaces:
IAsset, ICatalog, IModel, IModelDataModel, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class ModelDataModel extends Asset implements IModelDataModel, IModel, ICatalog, IAsset, IReferenceable
Instance of a data model in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static ModelDataModel.ModelDataModelBuilder<?,?> creator(String name, String connectionQualifiedName, DataModelType modelType)
      Builds the minimal object necessary to create a ModelDataModel.
      Parameters:
      name - of the ModelDataModel
      connectionQualifiedName - unique name of the connection in which this ModelDataModel exists
      modelType - type of model in which this entity exists
      Returns:
      the minimal request necessary to create the ModelDataModel, as a builder
    • updater

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static ModelDataModel.ModelDataModelBuilder<?,?> _internal()
    • toBuilder

      public ModelDataModel.ModelDataModelBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface IModel
      Specified by:
      getApplicationContainer in interface IModelDataModel
    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface IModel
      Specified by:
      getAssetApplicationQualifiedName in interface IModelDataModel
    • getInputToAirflowTasks

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

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

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IModel
      Specified by:
      getInputToSparkJobs in interface IModelDataModel
    • getModelBusinessDate

      public Long getModelBusinessDate()
      Business date for the asset.
      Specified by:
      getModelBusinessDate in interface IModel
      Specified by:
      getModelBusinessDate in interface IModelDataModel
    • getModelDomain

      public String getModelDomain()
      Model domain in which this asset exists.
      Specified by:
      getModelDomain in interface IModel
      Specified by:
      getModelDomain in interface IModelDataModel
    • getModelEntityName

      public String getModelEntityName()
      Simple name of the entity in which this asset exists, or empty if it is itself a data model entity.
      Specified by:
      getModelEntityName in interface IModel
      Specified by:
      getModelEntityName in interface IModelDataModel
    • getModelEntityQualifiedName

      public String getModelEntityQualifiedName()
      Unique name of the entity in which this asset exists, or empty if it is itself a data model entity.
      Specified by:
      getModelEntityQualifiedName in interface IModel
      Specified by:
      getModelEntityQualifiedName in interface IModelDataModel
    • getModelExpiredAtBusinessDate

      public Long getModelExpiredAtBusinessDate()
      Business expiration date for the asset.
      Specified by:
      getModelExpiredAtBusinessDate in interface IModel
      Specified by:
      getModelExpiredAtBusinessDate in interface IModelDataModel
    • getModelExpiredAtSystemDate

      public Long getModelExpiredAtSystemDate()
      System expiration date for the asset.
      Specified by:
      getModelExpiredAtSystemDate in interface IModel
      Specified by:
      getModelExpiredAtSystemDate in interface IModelDataModel
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IModel
      Specified by:
      getModelImplementedEntities in interface IModelDataModel
    • getModelName

      public String getModelName()
      Simple name of the model in which this asset exists, or empty if it is itself a data model.
      Specified by:
      getModelName in interface IModel
      Specified by:
      getModelName in interface IModelDataModel
    • getModelNamespace

      public String getModelNamespace()
      Model namespace in which this asset exists.
      Specified by:
      getModelNamespace in interface IModel
      Specified by:
      getModelNamespace in interface IModelDataModel
    • getModelQualifiedName

      public String getModelQualifiedName()
      Unique name of the model in which this asset exists, or empty if it is itself a data model.
      Specified by:
      getModelQualifiedName in interface IModel
      Specified by:
      getModelQualifiedName in interface IModelDataModel
    • getModelSystemDate

      public Long getModelSystemDate()
      System date for the asset.
      Specified by:
      getModelSystemDate in interface IModel
      Specified by:
      getModelSystemDate in interface IModelDataModel
    • getModelTool

      public String getModelTool()
      Tool used to create this data model.
      Specified by:
      getModelTool in interface IModelDataModel
    • getModelType

      public String getModelType()
      Type of the model asset (conceptual, logical, physical).
      Specified by:
      getModelType in interface IModel
      Specified by:
      getModelType in interface IModelDataModel
    • getModelVersionAgnosticQualifiedName

      public String getModelVersionAgnosticQualifiedName()
      Unique name of the parent in which this asset exists, irrespective of the version (always implies the latest version).
      Specified by:
      getModelVersionAgnosticQualifiedName in interface IModel
      Specified by:
      getModelVersionAgnosticQualifiedName in interface IModelDataModel
    • getModelVersionCount

      public Long getModelVersionCount()
      Number of versions of the data model.
      Specified by:
      getModelVersionCount in interface IModelDataModel
    • getModelVersionName

      public String getModelVersionName()
      Simple name of the version in which this asset exists, or empty if it is itself a data model version.
      Specified by:
      getModelVersionName in interface IModel
      Specified by:
      getModelVersionName in interface IModelDataModel
    • getModelVersionQualifiedName

      public String getModelVersionQualifiedName()
      Unique name of the version in which this asset exists, or empty if it is itself a data model version.
      Specified by:
      getModelVersionQualifiedName in interface IModel
      Specified by:
      getModelVersionQualifiedName in interface IModelDataModel
    • getModelVersions

      public SortedSet<IModelVersion> getModelVersions()
      Individual versions of the data model.
      Specified by:
      getModelVersions in interface IModelDataModel
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IModel
      Specified by:
      getOutputFromAirflowTasks in interface IModelDataModel
    • 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 IModel
      Specified by:
      getOutputFromProcesses in interface IModelDataModel
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IModel
      Specified by:
      getOutputFromSparkJobs in interface IModelDataModel
    • 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 ModelDataModels.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IModel
      Specified by:
      getTypeName in interface IModelDataModel
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference