Package com.atlan.model.assets

Class DMAttribute

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static DMAttribute.DMAttributeBuilder<?,?> _internal()

    • toBuilder

      public DMAttribute.DMAttributeBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getDmBusinessDate

      public Long getDmBusinessDate()
      Business date for the asset.
      Specified by:
      getDmBusinessDate in interface IDM
      Specified by:
      getDmBusinessDate in interface IDMAttribute

    • getDmDataModelDomain

      public String getDmDataModelDomain()
      A domain of the data model in which this asset exists.
      Specified by:
      getDmDataModelDomain in interface IDM
      Specified by:
      getDmDataModelDomain in interface IDMAttribute

    • getDmDataModelName

      public String getDmDataModelName()
      Simple name of the model in which this asset exists, or empty if it is itself a data model.
      Specified by:
      getDmDataModelName in interface IDM
      Specified by:
      getDmDataModelName in interface IDMAttribute

    • getDmDataModelNamespace

      public String getDmDataModelNamespace()
      A namespace of the data model in which this asset exists.
      Specified by:
      getDmDataModelNamespace in interface IDM
      Specified by:
      getDmDataModelNamespace in interface IDMAttribute

    • getDmDataModelQualifiedName

      public String getDmDataModelQualifiedName()
      Unique name of the model in which this asset exists, or empty if it is itself a data model.
      Specified by:
      getDmDataModelQualifiedName in interface IDM
      Specified by:
      getDmDataModelQualifiedName in interface IDMAttribute

    • getDmDataType

      public String getDmDataType()
      Type of the attribute.
      Specified by:
      getDmDataType in interface IDMAttribute

    • getDmEntities

      public SortedSet<IDMEntity> getDmEntities()
      Entity (or versions of an entity) in which this attribute exists.
      Specified by:
      getDmEntities in interface IDMAttribute

    • getDmEntityName

      public String getDmEntityName()
      Simple name of the entity in which this asset exists, or empty if it is itself a data model entity.
      Specified by:
      getDmEntityName in interface IDM
      Specified by:
      getDmEntityName in interface IDMAttribute

    • getDmEntityQualifiedName

      public String getDmEntityQualifiedName()
      Unique name of the entity in which this asset exists, or empty if it is itself a data model entity.
      Specified by:
      getDmEntityQualifiedName in interface IDM
      Specified by:
      getDmEntityQualifiedName in interface IDMAttribute

    • getDmExpiredAtBusinessDate

      public Long getDmExpiredAtBusinessDate()
      Business expiration date for the asset.
      Specified by:
      getDmExpiredAtBusinessDate in interface IDM
      Specified by:
      getDmExpiredAtBusinessDate in interface IDMAttribute

    • getDmExpiredAtSystemDate

      public Long getDmExpiredAtSystemDate()
      System expiration date for the asset.
      Specified by:
      getDmExpiredAtSystemDate in interface IDM
      Specified by:
      getDmExpiredAtSystemDate in interface IDMAttribute

    • getDmIsDerived

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

    • getDmIsForeign

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

    • getDmIsNullable

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

    • getDmIsPrimary

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

    • getDmMappedFromAttributes

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

    • getDmMappedToAttributes

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

    • getDmPrecision

      public Long getDmPrecision()
      Precision of the attribute.
      Specified by:
      getDmPrecision in interface IDMAttribute

    • getDmRelatedFromAttributes

      public SortedSet<IDMAttributeAssociation> getDmRelatedFromAttributes()
      Association from this attribute is related.
      Specified by:
      getDmRelatedFromAttributes in interface IDMAttribute

    • getDmRelatedToAttributes

      public SortedSet<IDMAttributeAssociation> getDmRelatedToAttributes()
      Association to which this attribute is related.
      Specified by:
      getDmRelatedToAttributes in interface IDMAttribute

    • getDmScale

      public Long getDmScale()
      Scale of the attribute.
      Specified by:
      getDmScale in interface IDMAttribute

    • getDmSystemDate

      public Long getDmSystemDate()
      System date for the asset.
      Specified by:
      getDmSystemDate in interface IDM
      Specified by:
      getDmSystemDate in interface IDMAttribute

    • getDmVersionName

      public String getDmVersionName()
      Simple name of the version in which this asset exists, or empty if it is itself a data model version.
      Specified by:
      getDmVersionName in interface IDM
      Specified by:
      getDmVersionName in interface IDMAttribute

    • getDmVersionQualifiedName

      public String getDmVersionQualifiedName()
      Unique name of the version in which this asset exists, or empty if it is itself a data model version.
      Specified by:
      getDmVersionQualifiedName in interface IDM
      Specified by:
      getDmVersionQualifiedName in interface IDMAttribute

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IDM
      Specified by:
      getInputToAirflowTasks in interface IDMAttribute

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IDM
      Specified by:
      getInputToProcesses in interface IDMAttribute

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IDM
      Specified by:
      getInputToSparkJobs in interface IDMAttribute

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IDM
      Specified by:
      getOutputFromAirflowTasks in interface IDMAttribute

    • 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 IDM
      Specified by:
      getOutputFromProcesses in interface IDMAttribute

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IDM
      Specified by:
      getOutputFromSparkJobs in interface IDMAttribute

    • 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 DMAttributes.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IDM
      Specified by:
      getTypeName in interface IDMAttribute
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference