Package com.atlan.model.assets

Class Column

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • getParent

      public ISQL getParent()
      Retrieve the parent of this Column, irrespective of its type.
      Returns:
      the reference to this Column's parent

    • creator

      public static Column.ColumnBuilder<?,?> creator(String name, Table table, int order) throws InvalidRequestException
      Builds the minimal object necessary to create a Column.
      Parameters:
      name - of the Column
      table - in which the Column should be created, which must have at least a qualifiedName
      order - the order the Column appears within its table (the Column's position)
      Returns:
      the minimal request necessary to create the Column, as a builder
      Throws:
      InvalidRequestException - if the table provided is without a qualifiedName

    • creator

      public static Column.ColumnBuilder<?,?> creator(String name, TablePartition partition, int order) throws InvalidRequestException
      Builds the minimal object necessary to create a Column.
      Parameters:
      name - of the Column
      partition - in which the Column should be created, which must have at least a qualifiedName
      order - the order the Column appears within its partition (the Column's position)
      Returns:
      the minimal request necessary to create the Column, as a builder
      Throws:
      InvalidRequestException - if the partition provided is without a qualifiedName

    • creator

      public static Column.ColumnBuilder<?,?> creator(String name, View view, int order) throws InvalidRequestException
      Builds the minimal object necessary to create a Column.
      Parameters:
      name - of the Column
      view - in which the Column should be created, which must have at least a qualifiedName
      order - the order the Column appears within its view (the Column's position)
      Returns:
      the minimal request necessary to create the Column, as a builder
      Throws:
      InvalidRequestException - if the view provided is without a qualifiedName

    • creator

      public static Column.ColumnBuilder<?,?> creator(String name, MaterializedView view, int order) throws InvalidRequestException
      Builds the minimal object necessary to create a Column.
      Parameters:
      name - of the Column
      view - in which the Column should be created, which must have at least a qualifiedName
      order - the order the Column appears within its materialized view (the Column's position)
      Returns:
      the minimal request necessary to create the Column, as a builder
      Throws:
      InvalidRequestException - if the materialized view provided is without a qualifiedName

    • creator

      public static Column.ColumnBuilder<?,?> creator(String name, String parentType, String parentQualifiedName, int order)
      Builds the minimal object necessary to create a Column.
      Parameters:
      name - of the Column
      parentType - type of parent (table, view, materialized view), should be a TYPE_NAME static string
      parentQualifiedName - unique name of the table / view / materialized view in which this Column exists
      order - the order the Column appears within its parent (the Column's position)
      Returns:
      the minimal request necessary to create the Column, as a builder

    • creator

      public static Column.ColumnBuilder<?,?> creator(String name, String connectionQualifiedName, String databaseName, String databaseQualifiedName, String schemaName, String schemaQualifiedName, String parentName, String parentQualifiedName, String parentType, String tableName, String tableQualifiedName, int order)
      Builds the minimal object necessary to create a Column.
      Parameters:
      name - of the Column
      connectionQualifiedName - unique name of the connection in which the Column should be created
      databaseName - simple name of the database in which the Column should be created
      databaseQualifiedName - unique name of the database in which the Column should be created
      schemaName - simple name of the schema in which the Column should be created
      schemaQualifiedName - unique name of the schema in which the Column should be created
      parentName - simple name of the table / view / materialized view in which the Column should be created
      parentQualifiedName - unique name of the table / view / materialized view in which this Column exists
      parentType - type of parent (table, view, materialized view), should be a TYPE_NAME static string
      tableName - simple name of the table if the parentType is TablePartition
      tableQualifiedName - unique name of the table if the parentType is TablePartition
      order - the order the Column appears within its parent (the Column's position)
      Returns:
      the minimal request necessary to create the Column, as a builder

    • generateQualifiedName

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static Column.ColumnBuilder<?,?> _internal()

    • toBuilder

      public Column.ColumnBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getCalculationView

      public ICalculationView getCalculationView()
      Calculate view in which this column exists.
      Specified by:
      getCalculationView in interface IColumn

    • getCalculationViewName

      public String getCalculationViewName()
      Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
      Specified by:
      getCalculationViewName in interface IColumn
      Specified by:
      getCalculationViewName in interface ISQL

    • getCalculationViewQualifiedName

      public String getCalculationViewQualifiedName()
      Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
      Specified by:
      getCalculationViewQualifiedName in interface IColumn
      Specified by:
      getCalculationViewQualifiedName in interface ISQL

    • getColumnAverage

      public Double getColumnAverage()
      Average value in this column.
      Specified by:
      getColumnAverage in interface IColumn

    • getColumnAverageLength

      public Double getColumnAverageLength()
      Average length of values in a string column.
      Specified by:
      getColumnAverageLength in interface IColumn

    • getColumnDbtModelColumns

      public SortedSet<IDbtModelColumn> getColumnDbtModelColumns()
      TBC
      Specified by:
      getColumnDbtModelColumns in interface IColumn

    • getColumnDepthLevel

      public Integer getColumnDepthLevel()
      Level of nesting of this column, used for STRUCT and NESTED columns.
      Specified by:
      getColumnDepthLevel in interface IColumn

    • getColumnDistinctValuesCount

      public Integer getColumnDistinctValuesCount()
      Number of rows that contain distinct values.
      Specified by:
      getColumnDistinctValuesCount in interface IColumn

    • getColumnDistinctValuesCountLong

      public Long getColumnDistinctValuesCountLong()
      Number of rows that contain distinct values.
      Specified by:
      getColumnDistinctValuesCountLong in interface IColumn

    • getColumnDuplicateValuesCount

      public Integer getColumnDuplicateValuesCount()
      Number of rows that contain duplicate values.
      Specified by:
      getColumnDuplicateValuesCount in interface IColumn

    • getColumnDuplicateValuesCountLong

      public Long getColumnDuplicateValuesCountLong()
      Number of rows that contain duplicate values.
      Specified by:
      getColumnDuplicateValuesCountLong in interface IColumn

    • getColumnHierarchy

      public List<Map<String,String>> getColumnHierarchy()
      List of top-level upstream nested columns.
      Specified by:
      getColumnHierarchy in interface IColumn

    • getColumnHistogram

      public Histogram getColumnHistogram()
      List of values in a histogram that represents the contents of this column.
      Specified by:
      getColumnHistogram in interface IColumn

    • getColumnMax

      public Double getColumnMax()
      Greatest value in a numeric column.
      Specified by:
      getColumnMax in interface IColumn

    • getColumnMaximumStringLength

      public Integer getColumnMaximumStringLength()
      Length of the longest value in a string column.
      Specified by:
      getColumnMaximumStringLength in interface IColumn

    • getColumnMaxs

      public SortedSet<String> getColumnMaxs()
      List of the greatest values in a column.
      Specified by:
      getColumnMaxs in interface IColumn

    • getColumnMean

      public Double getColumnMean()
      Arithmetic mean of the values in a numeric column.
      Specified by:
      getColumnMean in interface IColumn

    • getColumnMedian

      public Double getColumnMedian()
      Calculated median of the values in a numeric column.
      Specified by:
      getColumnMedian in interface IColumn

    • getColumnMin

      public Double getColumnMin()
      Least value in a numeric column.
      Specified by:
      getColumnMin in interface IColumn

    • getColumnMinimumStringLength

      public Integer getColumnMinimumStringLength()
      Length of the shortest value in a string column.
      Specified by:
      getColumnMinimumStringLength in interface IColumn

    • getColumnMins

      public SortedSet<String> getColumnMins()
      List of the least values in a column.
      Specified by:
      getColumnMins in interface IColumn

    • getColumnMissingValuesCount

      public Integer getColumnMissingValuesCount()
      Number of rows in a column that do not contain content.
      Specified by:
      getColumnMissingValuesCount in interface IColumn

    • getColumnMissingValuesCountLong

      public Long getColumnMissingValuesCountLong()
      Number of rows in a column that do not contain content.
      Specified by:
      getColumnMissingValuesCountLong in interface IColumn

    • getColumnMissingValuesPercentage

      public Double getColumnMissingValuesPercentage()
      Percentage of rows in a column that do not contain content.
      Specified by:
      getColumnMissingValuesPercentage in interface IColumn

    • getColumnStandardDeviation

      public Double getColumnStandardDeviation()
      Calculated standard deviation of the values in a numeric column.
      Specified by:
      getColumnStandardDeviation in interface IColumn

    • getColumnSum

      public Double getColumnSum()
      Calculated sum of the values in a numeric column.
      Specified by:
      getColumnSum in interface IColumn

    • getColumnTopValues

      public List<ColumnValueFrequencyMap> getColumnTopValues()
      List of top values in this column.
      Specified by:
      getColumnTopValues in interface IColumn

    • getColumnUniqueValuesCount

      public Integer getColumnUniqueValuesCount()
      Number of rows in which a value in this column appears only once.
      Specified by:
      getColumnUniqueValuesCount in interface IColumn

    • getColumnUniqueValuesCountLong

      public Long getColumnUniqueValuesCountLong()
      Number of rows in which a value in this column appears only once.
      Specified by:
      getColumnUniqueValuesCountLong in interface IColumn

    • getColumnUniquenessPercentage

      public Double getColumnUniquenessPercentage()
      Ratio indicating how unique data in this column is: 0 indicates that all values are the same, 100 indicates that all values in this column are unique.
      Specified by:
      getColumnUniquenessPercentage in interface IColumn

    • getColumnVariance

      public Double getColumnVariance()
      Calculated variance of the values in a numeric column.
      Specified by:
      getColumnVariance in interface IColumn

    • getCosmosMongoDBCollection

      public ICosmosMongoDBCollection getCosmosMongoDBCollection()
      Cosmos collection in which this column exists.
      Specified by:
      getCosmosMongoDBCollection in interface IColumn

    • getDataQualityMetricDimensions

      public SortedSet<IMetric> getDataQualityMetricDimensions()
      TBC
      Specified by:
      getDataQualityMetricDimensions in interface IColumn

    • getDataType

      public String getDataType()
      Data type of values in this column.
      Specified by:
      getDataType in interface IColumn

    • getDatabaseName

      public String getDatabaseName()
      Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
      Specified by:
      getDatabaseName in interface IColumn
      Specified by:
      getDatabaseName in interface ISQL

    • getDatabaseQualifiedName

      public String getDatabaseQualifiedName()
      Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
      Specified by:
      getDatabaseQualifiedName in interface IColumn
      Specified by:
      getDatabaseQualifiedName in interface ISQL

    • getDbtMetrics

      public SortedSet<IDbtMetric> getDbtMetrics()
      TBC
      Specified by:
      getDbtMetrics in interface IColumn

    • getDbtModelColumns

      public SortedSet<IDbtModelColumn> getDbtModelColumns()
      TBC
      Specified by:
      getDbtModelColumns in interface IColumn

    • getDbtModels

      public SortedSet<IDbtModel> getDbtModels()
      TBC
      Specified by:
      getDbtModels in interface IColumn
      Specified by:
      getDbtModels in interface ISQL

    • getDbtSources

      public SortedSet<IDbtSource> getDbtSources()
      TBC
      Specified by:
      getDbtSources in interface IColumn
      Specified by:
      getDbtSources in interface ISQL

    • getDbtTests

      public SortedSet<IDbtTest> getDbtTests()
      TBC
      Specified by:
      getDbtTests in interface IColumn
      Specified by:
      getDbtTests in interface ISQL

    • getDefaultValue

      public String getDefaultValue()
      Default value for this column.
      Specified by:
      getDefaultValue in interface IColumn

    • getForeignKeyFrom

      public IColumn getForeignKeyFrom()
      Column this foreign key column refers to.
      Specified by:
      getForeignKeyFrom in interface IColumn

    • getForeignKeyTo

      public SortedSet<IColumn> getForeignKeyTo()
      Columns that use this column as a foreign key.
      Specified by:
      getForeignKeyTo in interface IColumn

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IColumn
      Specified by:
      getInputToSparkJobs in interface ISQL

    • getIsClustered

      public Boolean getIsClustered()
      Whether this column is a clustered column (true) or not (false).
      Specified by:
      getIsClustered in interface IColumn

    • getIsDist

      public Boolean getIsDist()
      Whether this column is a distribution column (true) or not (false).
      Specified by:
      getIsDist in interface IColumn

    • getIsForeign

      public Boolean getIsForeign()
      When true, this column is a foreign key to another table. NOTE: this must be true when using the foreignKeyTo relationship to specify columns that refer to this column as a foreign key.
      Specified by:
      getIsForeign in interface IColumn

    • getIsIndexed

      public Boolean getIsIndexed()
      When true, this column is indexed in the database.
      Specified by:
      getIsIndexed in interface IColumn

    • getIsNullable

      public Boolean getIsNullable()
      When true, the values in this column can be null.
      Specified by:
      getIsNullable in interface IColumn

    • getIsPartition

      public Boolean getIsPartition()
      Whether this column is a partition column (true) or not (false).
      Specified by:
      getIsPartition in interface IColumn

    • getIsPinned

      public Boolean getIsPinned()
      Whether this column is pinned (true) or not (false).
      Specified by:
      getIsPinned in interface IColumn

    • getIsPrimary

      public Boolean getIsPrimary()
      When true, this column is the primary key for the table.
      Specified by:
      getIsPrimary in interface IColumn

    • getIsProfiled

      public Boolean getIsProfiled()
      Whether this asset has been profiled (true) or not (false).
      Specified by:
      getIsProfiled in interface IColumn
      Specified by:
      getIsProfiled in interface ISQL

    • getIsSort

      public Boolean getIsSort()
      Whether this column is a sort column (true) or not (false).
      Specified by:
      getIsSort in interface IColumn

    • getLastProfiledAt

      public Long getLastProfiledAt()
      Time (epoch) at which this asset was last profiled, in milliseconds.
      Specified by:
      getLastProfiledAt in interface IColumn
      Specified by:
      getLastProfiledAt in interface ISQL

    • getMaterializedView

      public IMaterializedView getMaterializedView()
      Materialized view in which this column exists.
      Specified by:
      getMaterializedView in interface IColumn

    • getMaxLength

      public Long getMaxLength()
      Maximum length of a value in this column.
      Specified by:
      getMaxLength in interface IColumn

    • getMetricTimestamps

      public SortedSet<IMetric> getMetricTimestamps()
      TBC
      Specified by:
      getMetricTimestamps in interface IColumn

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IColumn
      Specified by:
      getModelImplementedEntities in interface ISQL

    • getNestedColumnCount

      public Integer getNestedColumnCount()
      Number of columns nested within this (STRUCT or NESTED) column.
      Specified by:
      getNestedColumnCount in interface IColumn

    • getNestedColumnOrder

      public String getNestedColumnOrder()
      Order (position) in which this column appears in the nested Column (nest level starts at 1).
      Specified by:
      getNestedColumnOrder in interface IColumn

    • getNestedColumns

      public SortedSet<IColumn> getNestedColumns()
      Nested columns that exist within this column.
      Specified by:
      getNestedColumns in interface IColumn

    • getNosqlCollectionName

      public String getNosqlCollectionName()
      Simple name of the cosmos/mongo collection in which this SQL asset (column) exists, or empty if it does not exist within a cosmos/mongo collection.
      Specified by:
      getNosqlCollectionName in interface IColumn

    • getNosqlCollectionQualifiedName

      public String getNosqlCollectionQualifiedName()
      Unique name of the cosmos/mongo collection in which this SQL asset (column) exists, or empty if it does not exist within a cosmos/mongo collection.
      Specified by:
      getNosqlCollectionQualifiedName in interface IColumn

    • getNumericScale

      public Double getNumericScale()
      Number of digits allowed to the right of the decimal point.
      Specified by:
      getNumericScale in interface IColumn

    • getOrder

      public Integer getOrder()
      Order (position) in which this column appears in the table (starting at 1).
      Specified by:
      getOrder in interface IColumn

    • getOutputFromAirflowTasks

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

    • 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 IColumn
      Specified by:
      getOutputFromProcesses in interface ISQL

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IColumn
      Specified by:
      getOutputFromSparkJobs in interface ISQL

    • getParentColumn

      public IColumn getParentColumn()
      Column in which this sub-column is nested.
      Specified by:
      getParentColumn in interface IColumn

    • getParentColumnName

      public String getParentColumnName()
      Simple name of the column this column is nested within, for STRUCT and NESTED columns.
      Specified by:
      getParentColumnName in interface IColumn

    • getParentColumnQualifiedName

      public String getParentColumnQualifiedName()
      Unique name of the column this column is nested within, for STRUCT and NESTED columns.
      Specified by:
      getParentColumnQualifiedName in interface IColumn

    • getPartitionOrder

      public Integer getPartitionOrder()
      Order (position) of this partition column in the table.
      Specified by:
      getPartitionOrder in interface IColumn

    • getPinnedAt

      public Long getPinnedAt()
      Time (epoch) at which this column was pinned, in milliseconds.
      Specified by:
      getPinnedAt in interface IColumn

    • getPinnedBy

      public String getPinnedBy()
      User who pinned this column.
      Specified by:
      getPinnedBy in interface IColumn

    • getPrecision

      public Integer getPrecision()
      Total number of digits allowed, when the dataType is numeric.
      Specified by:
      getPrecision in interface IColumn

    • getQueries

      public SortedSet<IAtlanQuery> getQueries()
      Queries that access this column.
      Specified by:
      getQueries in interface IColumn

    • getQueryCount

      public Long getQueryCount()
      Number of times this asset has been queried.
      Specified by:
      getQueryCount in interface IColumn
      Specified by:
      getQueryCount in interface ISQL

    • getQueryCountUpdatedAt

      public Long getQueryCountUpdatedAt()
      Time (epoch) at which the query count was last updated, in milliseconds.
      Specified by:
      getQueryCountUpdatedAt in interface IColumn
      Specified by:
      getQueryCountUpdatedAt in interface ISQL

    • getQueryUserCount

      public Long getQueryUserCount()
      Number of unique users who have queried this asset.
      Specified by:
      getQueryUserCount in interface IColumn
      Specified by:
      getQueryUserCount in interface ISQL

    • getQueryUserMap

      public Map<String,Long> getQueryUserMap()
      Map of unique users who have queried this asset to the number of times they have queried it.
      Specified by:
      getQueryUserMap in interface IColumn
      Specified by:
      getQueryUserMap in interface ISQL

    • getRawDataTypeDefinition

      public String getRawDataTypeDefinition()
      TBC
      Specified by:
      getRawDataTypeDefinition in interface IColumn

    • getSchemaName

      public String getSchemaName()
      Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
      Specified by:
      getSchemaName in interface IColumn
      Specified by:
      getSchemaName in interface ISQL

    • getSchemaQualifiedName

      public String getSchemaQualifiedName()
      Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
      Specified by:
      getSchemaQualifiedName in interface IColumn
      Specified by:
      getSchemaQualifiedName in interface ISQL

    • getSnowflakeDynamicTable

      public ISnowflakeDynamicTable getSnowflakeDynamicTable()
      Snowflake dynamic table in which this column exists.
      Specified by:
      getSnowflakeDynamicTable in interface IColumn

    • getSqlDBTSources

      public SortedSet<IDbtSource> getSqlDBTSources()
      TBC
      Specified by:
      getSqlDBTSources in interface IColumn
      Specified by:
      getSqlDBTSources in interface ISQL

    • getSqlDbtModels

      public SortedSet<IDbtModel> getSqlDbtModels()
      TBC
      Specified by:
      getSqlDbtModels in interface IColumn
      Specified by:
      getSqlDbtModels in interface ISQL

    • getSubDataType

      public String getSubDataType()
      Sub-data type of this column.
      Specified by:
      getSubDataType in interface IColumn

    • getTable

      public ITable getTable()
      Table in which this column exists.
      Specified by:
      getTable in interface IColumn

    • getTableName

      public String getTableName()
      Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
      Specified by:
      getTableName in interface IColumn
      Specified by:
      getTableName in interface ISQL

    • getTablePartition

      public ITablePartition getTablePartition()
      Table partition that contains this column.
      Specified by:
      getTablePartition in interface IColumn

    • getTableQualifiedName

      public String getTableQualifiedName()
      Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
      Specified by:
      getTableQualifiedName in interface IColumn
      Specified by:
      getTableQualifiedName in interface ISQL

    • getValidations

      public Map<String,String> getValidations()
      Validations for this column.
      Specified by:
      getValidations in interface IColumn

    • getView

      public IView getView()
      View in which this column exists.
      Specified by:
      getView in interface IColumn

    • getViewName

      public String getViewName()
      Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
      Specified by:
      getViewName in interface IColumn
      Specified by:
      getViewName in interface ISQL

    • getViewQualifiedName

      public String getViewQualifiedName()
      Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
      Specified by:
      getViewQualifiedName in interface IColumn
      Specified by:
      getViewQualifiedName in interface ISQL

    • 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 Columns.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IColumn
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISQL
      Overrides:
      getTypeName in class Reference