Package com.atlan.model.assets

Class ModelAttribute

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

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

    • creator

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

    • creator

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

    • updater

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

    • updaterForVersion

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

    • generateQualifiedName

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static ModelAttribute.ModelAttributeBuilder<?,?> _internal()

    • toBuilder

      public ModelAttribute.ModelAttributeBuilder<?,?> 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 IModelAttribute

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

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

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

    • getInputToSparkJobs

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

    • getModelAttributeDataType

      public String getModelAttributeDataType()
      Type of the attribute.
      Specified by:
      getModelAttributeDataType in interface IModelAttribute

    • getModelAttributeEntities

      public SortedSet<IModelEntity> getModelAttributeEntities()
      Entity (or versions of an entity) in which this attribute exists.
      Specified by:
      getModelAttributeEntities in interface IModelAttribute

    • getModelAttributeHasRelationships

      public Boolean getModelAttributeHasRelationships()
      When true, this attribute has relationships with other attributes.
      Specified by:
      getModelAttributeHasRelationships in interface IModelAttribute

    • getModelAttributeIsDerived

      public Boolean getModelAttributeIsDerived()
      When true, the values in this attribute are derived data.
      Specified by:
      getModelAttributeIsDerived in interface IModelAttribute

    • getModelAttributeIsForeign

      public Boolean getModelAttributeIsForeign()
      When true, this attribute is a foreign key to another entity.
      Specified by:
      getModelAttributeIsForeign in interface IModelAttribute

    • getModelAttributeIsNullable

      public Boolean getModelAttributeIsNullable()
      When true, the values in this attribute can be null.
      Specified by:
      getModelAttributeIsNullable in interface IModelAttribute

    • getModelAttributeIsPrimary

      public Boolean getModelAttributeIsPrimary()
      When true, this attribute forms the primary key for the entity.
      Specified by:
      getModelAttributeIsPrimary in interface IModelAttribute

    • getModelAttributeMappedFromAttributes

      public SortedSet<IModelAttribute> getModelAttributeMappedFromAttributes()
      Attributes from which this attribute is mapped.
      Specified by:
      getModelAttributeMappedFromAttributes in interface IModelAttribute

    • getModelAttributeMappedToAttributes

      public SortedSet<IModelAttribute> getModelAttributeMappedToAttributes()
      Attributes to which this attribute is mapped.
      Specified by:
      getModelAttributeMappedToAttributes in interface IModelAttribute

    • getModelAttributePrecision

      public Long getModelAttributePrecision()
      Precision of the attribute.
      Specified by:
      getModelAttributePrecision in interface IModelAttribute

    • getModelAttributeRelatedFromAttributes

      public SortedSet<IModelAttributeAssociation> getModelAttributeRelatedFromAttributes()
      Association from which this attribute is related.
      Specified by:
      getModelAttributeRelatedFromAttributes in interface IModelAttribute

    • getModelAttributeRelatedToAttributes

      public SortedSet<IModelAttributeAssociation> getModelAttributeRelatedToAttributes()
      Association to which this attribute is related.
      Specified by:
      getModelAttributeRelatedToAttributes in interface IModelAttribute

    • getModelAttributeScale

      public Long getModelAttributeScale()
      Scale of the attribute.
      Specified by:
      getModelAttributeScale in interface IModelAttribute

    • getModelBusinessDate

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

    • getModelDomain

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

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

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

    • getModelExpiredAtBusinessDate

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

    • getModelExpiredAtSystemDate

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

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

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

    • getModelNamespace

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

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

    • getModelSystemDate

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

    • getModelType

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

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

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

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

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

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

    • getOutputFromSparkJobs

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

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