Package com.atlan.model.assets

Class ModelEntity

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.ModelEntity
All Implemented Interfaces:
IAsset, ICatalog, IModel, IModelEntity, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class ModelEntity extends Asset implements IModelEntity, IModel, ICatalog, IAsset, IReferenceable
Instance of an entity within a version of a data model in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

      public static ModelEntity.ModelEntityBuilder<?,?> creator(String name, ModelDataModel model) throws InvalidRequestException
      Builds the minimal object necessary to create a ModelEntity.
      Parameters:
      name - of the ModelEntity
      model - (version-agnostic) in which the entity should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the ModelEntity, as a builder
      Throws:
      InvalidRequestException - if the model provided is without a qualifiedName

    • creator

      public static ModelEntity.ModelEntityBuilder<?,?> creator(String name, String modelQualifiedName, String modelType)
      Builds the minimal object necessary to create a ModelEntity.
      Parameters:
      name - of the ModelEntity
      modelQualifiedName - unique (version-agnostic) name of the model in which this ModelEntity exists
      modelType - type of model in which this entity exists
      Returns:
      the minimal request necessary to create the ModelEntity, as a builder

    • creator

      public static ModelEntity.ModelEntityBuilder<?,?> creator(String name, String connectionQualifiedName, String modelName, String modelQualifiedName, String modelType)
      Builds the minimal object necessary to create a ModelEntity.
      Parameters:
      name - of the ModelEntity
      connectionQualifiedName - unique name of the connection in which to create this ModelEntity
      modelName - simple name (version-agnostic) of the model in which to create this ModelEntity
      modelQualifiedName - unique name (version-agnostic) of the model in which to create this ModelEntity
      modelType - type of model in which this entity exists
      Returns:
      the minimal request necessary to create the ModelEntity, as a builder

    • creatorForVersion

      public static ModelEntity.ModelEntityBuilder<?,?> creatorForVersion(String name, ModelVersion version) throws InvalidRequestException
      Builds the minimal object necessary to create a ModelEntity.
      Parameters:
      name - of the ModelEntity
      version - in which the entity should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the ModelEntity, as a builder
      Throws:
      InvalidRequestException - if the version provided is without a qualifiedName

    • creatorForVersion

      public static ModelEntity.ModelEntityBuilder<?,?> creatorForVersion(String name, String versionQualifiedName)
      Builds the minimal object necessary to create a ModelEntity.
      Parameters:
      name - of the ModelEntity
      versionQualifiedName - unique name of the version in which this ModelEntity exists
      Returns:
      the minimal request necessary to create the ModelEntity, as a builder

    • creatorForVersion

      public static ModelEntity.ModelEntityBuilder<?,?> creatorForVersion(String name, String connectionQualifiedName, String versionName, String versionQualifiedName)
      Builds the minimal object necessary to create a ModelEntity.
      Parameters:
      name - of the ModelEntity
      connectionQualifiedName - unique name of the connection in which to create this ModelEntity
      versionName - simple name of the version in which to create this ModelEntity
      versionQualifiedName - unique name of the version in which to create this ModelEntity
      Returns:
      the minimal request necessary to create the ModelEntity, as a builder

    • updater

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

    • updaterForVersion

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

    • generateQualifiedName

      public static String generateQualifiedName(String name, String parentQualifiedName)
      Generate a unique ModelEntity name.
      Parameters:
      name - of the ModelEntity
      parentQualifiedName - unique name of the model or version in which this ModelEntity exists
      Returns:
      a unique name for the ModelEntity

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static ModelEntity.ModelEntityBuilder<?,?> _internal()

    • toBuilder

      public ModelEntity.ModelEntityBuilder<?,?> 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 IModelEntity

    • 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 IModelEntity

    • 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 IModelEntity

    • 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 IModelEntity

    • getInputToSparkJobs

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

    • getModelBusinessDate

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

    • getModelDomain

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

    • getModelEntityAttributeCount

      public Long getModelEntityAttributeCount()
      Number of attributes in the entity.
      Specified by:
      getModelEntityAttributeCount in interface IModelEntity

    • getModelEntityAttributes

      public SortedSet<IModelAttribute> getModelEntityAttributes()
      Individual attributes that make up the entity.
      Specified by:
      getModelEntityAttributes in interface IModelEntity

    • getModelEntityGeneralizationEntity

      public IModelEntity getModelEntityGeneralizationEntity()
      General entity, representing shared characteristics of specialized entities.
      Specified by:
      getModelEntityGeneralizationEntity in interface IModelEntity

    • getModelEntityGeneralizationName

      public String getModelEntityGeneralizationName()
      Name of the general entity.
      Specified by:
      getModelEntityGeneralizationName in interface IModelEntity

    • getModelEntityGeneralizationQualifiedName

      public String getModelEntityGeneralizationQualifiedName()
      Unique identifier for the general entity.
      Specified by:
      getModelEntityGeneralizationQualifiedName in interface IModelEntity

    • getModelEntityImplementedByAssets

      public SortedSet<ICatalog> getModelEntityImplementedByAssets()
      Assets that implement this entity.
      Specified by:
      getModelEntityImplementedByAssets in interface IModelEntity

    • getModelEntityMappedFromEntities

      public SortedSet<IModelEntity> getModelEntityMappedFromEntities()
      Entities from which this entity is mapped.
      Specified by:
      getModelEntityMappedFromEntities in interface IModelEntity

    • getModelEntityMappedToEntities

      public SortedSet<IModelEntity> getModelEntityMappedToEntities()
      Entities to which this entity is mapped.
      Specified by:
      getModelEntityMappedToEntities in interface IModelEntity

    • 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 IModelEntity

    • 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 IModelEntity

    • getModelEntityRelatedFromEntities

      public SortedSet<IModelEntityAssociation> getModelEntityRelatedFromEntities()
      Association from which this entity is related.
      Specified by:
      getModelEntityRelatedFromEntities in interface IModelEntity

    • getModelEntityRelatedToEntities

      public SortedSet<IModelEntityAssociation> getModelEntityRelatedToEntities()
      Association to which this entity is related.
      Specified by:
      getModelEntityRelatedToEntities in interface IModelEntity

    • getModelEntitySpecializationEntities

      public SortedSet<IModelEntity> getModelEntitySpecializationEntities()
      Specialized entities derived from the general entity.
      Specified by:
      getModelEntitySpecializationEntities in interface IModelEntity

    • getModelEntitySubjectArea

      public String getModelEntitySubjectArea()
      Subject area of the entity.
      Specified by:
      getModelEntitySubjectArea in interface IModelEntity

    • getModelExpiredAtBusinessDate

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

    • getModelExpiredAtSystemDate

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

    • 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 IModelEntity

    • 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 IModelEntity

    • getModelNamespace

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

    • 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 IModelEntity

    • getModelSystemDate

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

    • getModelType

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

    • 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 IModelEntity

    • 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 IModelEntity

    • 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 IModelEntity

    • getModelVersions

      public SortedSet<IModelVersion> getModelVersions()
      Data model version(s) in which this entity exists.
      Specified by:
      getModelVersions in interface IModelEntity

    • 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 IModelEntity

    • 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 IModelEntity

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IModel
      Specified by:
      getOutputFromSparkJobs in interface IModelEntity

    • 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 ModelEntitys.
      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 IModelEntity
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference