Package com.atlan.model.assets

Class ModelEntityAssociation

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

      public static ModelEntityAssociation.ModelEntityAssociationBuilder<?,?> creator(String name, ModelEntity from, ModelEntity to) throws InvalidRequestException
      Builds the minimal object necessary to create a ModelEntityAssociation.
      Parameters:
      name - of the ModelEntityAssociation
      from - entity (version-agnostic) from which the association exists
      to - entity (version-agnostic) to which the association exists
      Returns:
      the minimal request necessary to create the ModelEntityAssociation, as a builder
      Throws:
      InvalidRequestException - if the from or to are provided without a modelVersionAgnosticQualifiedName

    • creator

      public static ModelEntityAssociation.ModelEntityAssociationBuilder<?,?> creator(String name, String fromQualifiedName, String toQualifiedName)
      Builds the minimal object necessary to create a ModelEntityAssociation.
      Parameters:
      name - of the ModelEntityAssociation
      fromQualifiedName - unique (version-agnostic) name of the entity from which the association exists
      toQualifiedName - unique (version-agnostic) name of the entity to which the association exists
      Returns:
      the minimal request necessary to create the ModelEntityAssociation, as a builder

    • creator

      public static ModelEntityAssociation.ModelEntityAssociationBuilder<?,?> creator(String name, String connectionQualifiedName, String fromQualifiedName, String toQualifiedName)
      Builds the minimal object necessary to create a ModelEntityAssociation.
      Parameters:
      name - of the ModelEntityAssociation
      connectionQualifiedName - unique name of the connection in which to create this ModelEntityAssociation
      fromQualifiedName - unique (version-agnostic) name of the entity from which the association exists
      toQualifiedName - unique (version-agnostic) name of the entity to which the association exists
      Returns:
      the minimal request necessary to create the ModelEntityAssociation, as a builder

    • updater

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

    • updaterForVersion

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

    • generateQualifiedName

      public static String generateQualifiedName(String name, String fromQualifiedName, String toQualifiedName)
      Generate a unique ModelEntityAssociation name.
      Parameters:
      name - of the ModelEntityAssociation
      fromQualifiedName - unique (version-agnostic) name of the entity from which the association exists
      toQualifiedName - unique (version-agnostic) name of the entity to which the association exists
      Returns:
      a unique name for the ModelEntityAssociation

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static ModelEntityAssociation.ModelEntityAssociationBuilder<?,?> _internal()

    • toBuilder

      public ModelEntityAssociation.ModelEntityAssociationBuilder<?,?> 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 IModelEntityAssociation

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

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

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

    • getInputToSparkJobs

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

    • getModelBusinessDate

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

    • getModelDomain

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

    • getModelEntityAssociationCardinality

      public ModelCardinalityType getModelEntityAssociationCardinality()
      Cardinality of the data entity association.
      Specified by:
      getModelEntityAssociationCardinality in interface IModelEntityAssociation

    • getModelEntityAssociationFrom

      public IModelEntity getModelEntityAssociationFrom()
      Entity from which this association is related.
      Specified by:
      getModelEntityAssociationFrom in interface IModelEntityAssociation

    • getModelEntityAssociationFromQualifiedName

      public String getModelEntityAssociationFromQualifiedName()
      Unique name of the association from which this entity is related.
      Specified by:
      getModelEntityAssociationFromQualifiedName in interface IModelEntityAssociation

    • getModelEntityAssociationLabel

      public String getModelEntityAssociationLabel()
      Label of the data entity association.
      Specified by:
      getModelEntityAssociationLabel in interface IModelEntityAssociation

    • getModelEntityAssociationTo

      public IModelEntity getModelEntityAssociationTo()
      Entity to which this association is related.
      Specified by:
      getModelEntityAssociationTo in interface IModelEntityAssociation

    • getModelEntityAssociationToQualifiedName

      public String getModelEntityAssociationToQualifiedName()
      Unique name of the association to which this entity is related.
      Specified by:
      getModelEntityAssociationToQualifiedName in interface IModelEntityAssociation

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

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

    • getModelExpiredAtBusinessDate

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

    • getModelExpiredAtSystemDate

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

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

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

    • getModelNamespace

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

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

    • getModelSystemDate

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

    • getModelType

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

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

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

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

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

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

    • getOutputFromSparkJobs

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

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