Interface IColumn

All Known Implementing Classes:
Column

@Generated("com.atlan.generators.ModelGeneratorV2") public interface IColumn
Instance of a column in Atlan.
  • Field Details

    • TYPE_NAME

      static final String TYPE_NAME
      See Also:
    • CALCULATION_VIEW

      static final RelationField CALCULATION_VIEW
      Calculate view in which this column exists.
    • COLUMN_AVERAGE

      static final NumericField COLUMN_AVERAGE
      Average value in this column.
    • COLUMN_AVERAGE_LENGTH

      static final NumericField COLUMN_AVERAGE_LENGTH
      Average length of values in a string column.
    • COLUMN_DBT_MODEL_COLUMNS

      static final RelationField COLUMN_DBT_MODEL_COLUMNS
      TBC
    • COLUMN_DEPTH_LEVEL

      static final NumericField COLUMN_DEPTH_LEVEL
      Level of nesting of this column, used for STRUCT and NESTED columns.
    • COLUMN_DISTINCT_VALUES_COUNT

      static final NumericField COLUMN_DISTINCT_VALUES_COUNT
      Number of rows that contain distinct values.
    • COLUMN_DISTINCT_VALUES_COUNT_LONG

      static final NumericField COLUMN_DISTINCT_VALUES_COUNT_LONG
      Number of rows that contain distinct values.
    • COLUMN_DUPLICATE_VALUES_COUNT

      static final NumericField COLUMN_DUPLICATE_VALUES_COUNT
      Number of rows that contain duplicate values.
    • COLUMN_DUPLICATE_VALUES_COUNT_LONG

      static final NumericField COLUMN_DUPLICATE_VALUES_COUNT_LONG
      Number of rows that contain duplicate values.
    • COLUMN_HIERARCHY

      static final KeywordField COLUMN_HIERARCHY
      List of top-level upstream nested columns.
    • COLUMN_HISTOGRAM

      static final KeywordField COLUMN_HISTOGRAM
      List of values in a histogram that represents the contents of this column.
    • COLUMN_MAX

      static final NumericField COLUMN_MAX
      Greatest value in a numeric column.
    • COLUMN_MAXIMUM_STRING_LENGTH

      static final NumericField COLUMN_MAXIMUM_STRING_LENGTH
      Length of the longest value in a string column.
    • COLUMN_MAXS

      static final TextField COLUMN_MAXS
      List of the greatest values in a column.
    • COLUMN_MEAN

      static final NumericField COLUMN_MEAN
      Arithmetic mean of the values in a numeric column.
    • COLUMN_MEDIAN

      static final NumericField COLUMN_MEDIAN
      Calculated median of the values in a numeric column.
    • COLUMN_MIN

      static final NumericField COLUMN_MIN
      Least value in a numeric column.
    • COLUMN_MINIMUM_STRING_LENGTH

      static final NumericField COLUMN_MINIMUM_STRING_LENGTH
      Length of the shortest value in a string column.
    • COLUMN_MINS

      static final TextField COLUMN_MINS
      List of the least values in a column.
    • COLUMN_MISSING_VALUES_COUNT

      static final NumericField COLUMN_MISSING_VALUES_COUNT
      Number of rows in a column that do not contain content.
    • COLUMN_MISSING_VALUES_COUNT_LONG

      static final NumericField COLUMN_MISSING_VALUES_COUNT_LONG
      Number of rows in a column that do not contain content.
    • COLUMN_MISSING_VALUES_PERCENTAGE

      static final NumericField COLUMN_MISSING_VALUES_PERCENTAGE
      Percentage of rows in a column that do not contain content.
    • COLUMN_STANDARD_DEVIATION

      static final NumericField COLUMN_STANDARD_DEVIATION
      Calculated standard deviation of the values in a numeric column.
    • COLUMN_SUM

      static final NumericField COLUMN_SUM
      Calculated sum of the values in a numeric column.
    • COLUMN_TOP_VALUES

      static final KeywordField COLUMN_TOP_VALUES
      List of top values in this column.
    • COLUMN_UNIQUE_VALUES_COUNT

      static final NumericField COLUMN_UNIQUE_VALUES_COUNT
      Number of rows in which a value in this column appears only once.
    • COLUMN_UNIQUE_VALUES_COUNT_LONG

      static final NumericField COLUMN_UNIQUE_VALUES_COUNT_LONG
      Number of rows in which a value in this column appears only once.
    • COLUMN_UNIQUENESS_PERCENTAGE

      static final NumericField COLUMN_UNIQUENESS_PERCENTAGE
      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.
    • COLUMN_VARIANCE

      static final NumericField COLUMN_VARIANCE
      Calculated variance of the values in a numeric column.
    • COSMOS_MONGO_DB_COLLECTION

      static final RelationField COSMOS_MONGO_DB_COLLECTION
      Cosmos collection in which this column exists.
    • DATA_QUALITY_METRIC_DIMENSIONS

      static final RelationField DATA_QUALITY_METRIC_DIMENSIONS
      TBC
    • DATA_TYPE

      static final KeywordTextField DATA_TYPE
      Data type of values in this column.
    • DBT_METRICS

      static final RelationField DBT_METRICS
      TBC
    • DBT_MODEL_COLUMNS

      static final RelationField DBT_MODEL_COLUMNS
      TBC
    • DEFAULT_VALUE

      static final TextField DEFAULT_VALUE
      Default value for this column.
    • FOREIGN_KEY_FROM

      static final RelationField FOREIGN_KEY_FROM
      Column this foreign key column refers to.
    • FOREIGN_KEY_TO

      static final RelationField FOREIGN_KEY_TO
      Columns that use this column as a foreign key.
    • IS_CLUSTERED

      static final BooleanField IS_CLUSTERED
      Whether this column is a clustered column (true) or not (false).
    • IS_DIST

      static final BooleanField IS_DIST
      Whether this column is a distribution column (true) or not (false).
    • IS_FOREIGN

      static final BooleanField IS_FOREIGN
      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.
    • IS_INDEXED

      static final BooleanField IS_INDEXED
      When true, this column is indexed in the database.
    • IS_NULLABLE

      static final BooleanField IS_NULLABLE
      When true, the values in this column can be null.
    • IS_PARTITION

      static final BooleanField IS_PARTITION
      Whether this column is a partition column (true) or not (false).
    • IS_PINNED

      static final BooleanField IS_PINNED
      Whether this column is pinned (true) or not (false).
    • IS_PRIMARY

      static final BooleanField IS_PRIMARY
      When true, this column is the primary key for the table.
    • IS_SORT

      static final BooleanField IS_SORT
      Whether this column is a sort column (true) or not (false).
    • MATERIALIZED_VIEW

      static final RelationField MATERIALIZED_VIEW
      Materialized view in which this column exists.
    • MAX_LENGTH

      static final NumericField MAX_LENGTH
      Maximum length of a value in this column.
    • METRIC_TIMESTAMPS

      static final RelationField METRIC_TIMESTAMPS
      TBC
    • NESTED_COLUMN_COUNT

      static final NumericField NESTED_COLUMN_COUNT
      Number of columns nested within this (STRUCT or NESTED) column.
    • NESTED_COLUMN_ORDER

      static final KeywordField NESTED_COLUMN_ORDER
      Order (position) in which this column appears in the nested Column (nest level starts at 1).
    • NESTED_COLUMNS

      static final RelationField NESTED_COLUMNS
      Nested columns that exist within this column.
    • NOSQL_COLLECTION_NAME

      static final KeywordTextField NOSQL_COLLECTION_NAME
      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.
    • NOSQL_COLLECTION_QUALIFIED_NAME

      static final KeywordField NOSQL_COLLECTION_QUALIFIED_NAME
      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.
    • NUMERIC_SCALE

      static final NumericField NUMERIC_SCALE
      Number of digits allowed to the right of the decimal point.
    • ORDER

      static final NumericField ORDER
      Order (position) in which this column appears in the table (starting at 1).
    • PARENT_COLUMN

      static final RelationField PARENT_COLUMN
      Column in which this sub-column is nested.
    • PARENT_COLUMN_NAME

      static final KeywordTextField PARENT_COLUMN_NAME
      Simple name of the column this column is nested within, for STRUCT and NESTED columns.
    • PARENT_COLUMN_QUALIFIED_NAME

      static final KeywordTextField PARENT_COLUMN_QUALIFIED_NAME
      Unique name of the column this column is nested within, for STRUCT and NESTED columns.
    • PARTITION_ORDER

      static final NumericField PARTITION_ORDER
      Order (position) of this partition column in the table.
    • PINNED_AT

      static final NumericField PINNED_AT
      Time (epoch) at which this column was pinned, in milliseconds.
    • PINNED_BY

      static final KeywordField PINNED_BY
      User who pinned this column.
    • PRECISION

      static final NumericField PRECISION
      Total number of digits allowed, when the dataType is numeric.
    • QUERIES

      static final RelationField QUERIES
      Queries that access this column.
    • RAW_DATA_TYPE_DEFINITION

      static final TextField RAW_DATA_TYPE_DEFINITION
      TBC
    • SNOWFLAKE_DYNAMIC_TABLE

      static final RelationField SNOWFLAKE_DYNAMIC_TABLE
      Snowflake dynamic table in which this column exists.
    • SUB_DATA_TYPE

      static final KeywordField SUB_DATA_TYPE
      Sub-data type of this column.
    • TABLE

      static final RelationField TABLE
      Table in which this column exists.
    • TABLE_PARTITION

      static final RelationField TABLE_PARTITION
      Table partition that contains this column.
    • VALIDATIONS

      static final KeywordField VALIDATIONS
      Validations for this column.
    • VIEW

      static final RelationField VIEW
      View in which this column exists.
  • Method Details

    • getAdminGroups

      SortedSet<String> getAdminGroups()
      List of groups who administer this asset. (This is only used for certain asset types.)
    • getAdminRoles

      SortedSet<String> getAdminRoles()
      List of roles who administer this asset. (This is only used for Connection assets.)
    • getAdminUsers

      SortedSet<String> getAdminUsers()
      List of users who administer this asset. (This is only used for certain asset types.)
    • getAnnouncementMessage

      String getAnnouncementMessage()
      Detailed message to include in the announcement on this asset.
    • getAnnouncementTitle

      String getAnnouncementTitle()
      Brief title for the announcement on this asset. Required when announcementType is specified.
    • getAnnouncementType

      AtlanAnnouncementType getAnnouncementType()
      Type of announcement on this asset.
    • getAnnouncementUpdatedAt

      Long getAnnouncementUpdatedAt()
      Time (epoch) at which the announcement was last updated, in milliseconds.
    • getAnnouncementUpdatedBy

      String getAnnouncementUpdatedBy()
      Name of the user who last updated the announcement.
    • getAnomaloChecks

      SortedSet<IAnomaloCheck> getAnomaloChecks()
      Checks that run on this asset.
    • getApplicationContainer

      IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
    • getAssetAnomaloAppliedCheckTypes

      SortedSet<String> getAssetAnomaloAppliedCheckTypes()
      All associated Anomalo check types.
    • getAssetAnomaloCheckCount

      Long getAssetAnomaloCheckCount()
      Total number of checks present in Anomalo for this asset.
    • getAssetAnomaloCheckStatuses

      String getAssetAnomaloCheckStatuses()
      Stringified JSON object containing status of all Anomalo checks associated to this asset.
    • getAssetAnomaloDQStatus

      String getAssetAnomaloDQStatus()
      Status of data quality from Anomalo.
    • getAssetAnomaloFailedCheckCount

      Long getAssetAnomaloFailedCheckCount()
      Total number of checks failed in Anomalo for this asset.
    • getAssetAnomaloFailedCheckTypes

      SortedSet<String> getAssetAnomaloFailedCheckTypes()
      All associated Anomalo failed check types.
    • getAssetAnomaloLastCheckRunAt

      Long getAssetAnomaloLastCheckRunAt()
      Time (epoch) at which the last check was run via Anomalo.
    • getAssetAnomaloSourceUrl

      String getAssetAnomaloSourceUrl()
      URL of the source in Anomalo.
    • getAssetApplicationQualifiedName

      String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
    • getAssetCoverImage

      String getAssetCoverImage()
      TBC
    • getAssetDbtAccountName

      String getAssetDbtAccountName()
      Name of the account in which this asset exists in dbt.
    • getAssetDbtAlias

      String getAssetDbtAlias()
      Alias of this asset in dbt.
    • getAssetDbtEnvironmentDbtVersion

      String getAssetDbtEnvironmentDbtVersion()
      Version of the environment in which this asset is materialized in dbt.
    • getAssetDbtEnvironmentName

      String getAssetDbtEnvironmentName()
      Name of the environment in which this asset is materialized in dbt.
    • getAssetDbtJobLastRun

      Long getAssetDbtJobLastRun()
      Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.
    • getAssetDbtJobLastRunArtifactS3Path

      String getAssetDbtJobLastRunArtifactS3Path()
      Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunArtifactsSaved

      Boolean getAssetDbtJobLastRunArtifactsSaved()
      Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).
    • getAssetDbtJobLastRunCreatedAt

      Long getAssetDbtJobLastRunCreatedAt()
      Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.
    • getAssetDbtJobLastRunDequedAt

      Long getAssetDbtJobLastRunDequedAt()
      Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.
    • getAssetDbtJobLastRunExecutedByThreadId

      String getAssetDbtJobLastRunExecutedByThreadId()
      Thread ID of the user who executed the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunGitBranch

      String getAssetDbtJobLastRunGitBranch()
      Branch in git from which the last run of the job that materialized this asset in dbt ran.
    • getAssetDbtJobLastRunGitSha

      String getAssetDbtJobLastRunGitSha()
      SHA hash in git for the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunHasDocsGenerated

      Boolean getAssetDbtJobLastRunHasDocsGenerated()
      Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
    • getAssetDbtJobLastRunHasSourcesGenerated

      Boolean getAssetDbtJobLastRunHasSourcesGenerated()
      Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
    • getAssetDbtJobLastRunNotificationsSent

      Boolean getAssetDbtJobLastRunNotificationsSent()
      Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).
    • getAssetDbtJobLastRunOwnerThreadId

      String getAssetDbtJobLastRunOwnerThreadId()
      Thread ID of the owner of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunQueuedDuration

      String getAssetDbtJobLastRunQueuedDuration()
      Total duration the job that materialized this asset in dbt spent being queued.
    • getAssetDbtJobLastRunQueuedDurationHumanized

      String getAssetDbtJobLastRunQueuedDurationHumanized()
      Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.
    • getAssetDbtJobLastRunRunDuration

      String getAssetDbtJobLastRunRunDuration()
      Run duration of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunRunDurationHumanized

      String getAssetDbtJobLastRunRunDurationHumanized()
      Human-readable run duration of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunStartedAt

      Long getAssetDbtJobLastRunStartedAt()
      Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.
    • getAssetDbtJobLastRunStatusMessage

      String getAssetDbtJobLastRunStatusMessage()
      Status message of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunTotalDuration

      String getAssetDbtJobLastRunTotalDuration()
      Total duration of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunTotalDurationHumanized

      String getAssetDbtJobLastRunTotalDurationHumanized()
      Human-readable total duration of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobLastRunUpdatedAt

      Long getAssetDbtJobLastRunUpdatedAt()
      Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.
    • getAssetDbtJobLastRunUrl

      String getAssetDbtJobLastRunUrl()
      URL of the last run of the job that materialized this asset in dbt.
    • getAssetDbtJobName

      String getAssetDbtJobName()
      Name of the job that materialized this asset in dbt.
    • getAssetDbtJobNextRun

      Long getAssetDbtJobNextRun()
      Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.
    • getAssetDbtJobNextRunHumanized

      String getAssetDbtJobNextRunHumanized()
      Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.
    • getAssetDbtJobSchedule

      String getAssetDbtJobSchedule()
      Schedule of the job that materialized this asset in dbt.
    • getAssetDbtJobScheduleCronHumanized

      String getAssetDbtJobScheduleCronHumanized()
      Human-readable cron schedule of the job that materialized this asset in dbt.
    • getAssetDbtJobStatus

      String getAssetDbtJobStatus()
      Status of the job that materialized this asset in dbt.
    • getAssetDbtMeta

      String getAssetDbtMeta()
      Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.
    • getAssetDbtPackageName

      String getAssetDbtPackageName()
      Name of the package in which this asset exists in dbt.
    • getAssetDbtProjectName

      String getAssetDbtProjectName()
      Name of the project in which this asset exists in dbt.
    • getAssetDbtSemanticLayerProxyUrl

      String getAssetDbtSemanticLayerProxyUrl()
      URL of the semantic layer proxy for this asset in dbt.
    • getAssetDbtSourceFreshnessCriteria

      String getAssetDbtSourceFreshnessCriteria()
      Freshness criteria for the source of this asset in dbt.
    • getAssetDbtTags

      SortedSet<String> getAssetDbtTags()
      List of tags attached to this asset in dbt.
    • getAssetDbtTestStatus

      String getAssetDbtTestStatus()
      All associated dbt test statuses.
    • getAssetDbtUniqueId

      String getAssetDbtUniqueId()
      Unique identifier of this asset in dbt.
    • getAssetDbtWorkflowLastUpdated

      String getAssetDbtWorkflowLastUpdated()
      Name of the DBT workflow in Atlan that last updated the asset.
    • getAssetIcon

      AtlanIcon getAssetIcon()
      Name of the icon to use for this asset. (Only applies to glossaries, currently.)
    • getAssetMcAlertQualifiedNames

      SortedSet<String> getAssetMcAlertQualifiedNames()
      List of unique Monte Carlo alert names attached to this asset.
    • getAssetMcIncidentNames

      SortedSet<String> getAssetMcIncidentNames()
      List of Monte Carlo incident names attached to this asset.
    • getAssetMcIncidentPriorities

      SortedSet<String> getAssetMcIncidentPriorities()
      List of Monte Carlo incident priorities associated with this asset.
    • getAssetMcIncidentQualifiedNames

      SortedSet<String> getAssetMcIncidentQualifiedNames()
      List of unique Monte Carlo incident names attached to this asset.
    • getAssetMcIncidentSeverities

      SortedSet<String> getAssetMcIncidentSeverities()
      List of Monte Carlo incident severities associated with this asset.
    • getAssetMcIncidentStates

      SortedSet<String> getAssetMcIncidentStates()
      List of Monte Carlo incident states associated with this asset.
    • getAssetMcIncidentSubTypes

      SortedSet<String> getAssetMcIncidentSubTypes()
      List of Monte Carlo incident sub-types associated with this asset.
    • getAssetMcIncidentTypes

      SortedSet<String> getAssetMcIncidentTypes()
      List of Monte Carlo incident types associated with this asset.
    • getAssetMcLastSyncRunAt

      Long getAssetMcLastSyncRunAt()
      Time (epoch) at which this asset was last synced from Monte Carlo.
    • getAssetMcMonitorNames

      SortedSet<String> getAssetMcMonitorNames()
      List of Monte Carlo monitor names attached to this asset.
    • getAssetMcMonitorQualifiedNames

      SortedSet<String> getAssetMcMonitorQualifiedNames()
      List of unique Monte Carlo monitor names attached to this asset.
    • getAssetMcMonitorScheduleTypes

      SortedSet<String> getAssetMcMonitorScheduleTypes()
      Schedules of all associated Monte Carlo monitors.
    • getAssetMcMonitorStatuses

      SortedSet<String> getAssetMcMonitorStatuses()
      Statuses of all associated Monte Carlo monitors.
    • getAssetMcMonitorTypes

      SortedSet<String> getAssetMcMonitorTypes()
      Types of all associated Monte Carlo monitors.
    • getAssetPoliciesCount

      Long getAssetPoliciesCount()
      Count of policies inside the asset
    • getAssetPolicyGUIDs

      SortedSet<String> getAssetPolicyGUIDs()
      Array of policy ids governing this asset
    • getAssetSodaCheckCount

      Long getAssetSodaCheckCount()
      Number of checks done via Soda.
    • getAssetSodaCheckStatuses

      String getAssetSodaCheckStatuses()
      All associated Soda check statuses.
    • getAssetSodaDQStatus

      String getAssetSodaDQStatus()
      Status of data quality from Soda.
    • getAssetSodaLastScanAt

      Long getAssetSodaLastScanAt()
      TBC
    • getAssetSodaLastSyncRunAt

      Long getAssetSodaLastSyncRunAt()
      TBC
    • getAssetSodaSourceURL

      String getAssetSodaSourceURL()
      TBC
    • getAssetTags

      SortedSet<String> getAssetTags()
      List of tags attached to this asset.
    • getAssetThemeHex

      String getAssetThemeHex()
      Color (in hexadecimal RGB) to use to represent this asset.
    • getAssignedTerms

      SortedSet<IGlossaryTerm> getAssignedTerms()
      Glossary terms that are linked to this asset.
    • getCalculationView

      ICalculationView getCalculationView()
      Calculate view in which this column exists.
    • getCalculationViewName

      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.
    • getCalculationViewQualifiedName

      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.
    • getCertificateStatus

      CertificateStatus getCertificateStatus()
      Status of this asset's certification.
    • getCertificateStatusMessage

      String getCertificateStatusMessage()
      Human-readable descriptive message used to provide further detail to certificateStatus.
    • getCertificateUpdatedAt

      Long getCertificateUpdatedAt()
      Time (epoch) at which the certification was last updated, in milliseconds.
    • getCertificateUpdatedBy

      String getCertificateUpdatedBy()
      Name of the user who last updated the certification of this asset.
    • getColumnAverage

      Double getColumnAverage()
      Average value in this column.
    • getColumnAverageLength

      Double getColumnAverageLength()
      Average length of values in a string column.
    • getColumnDbtModelColumns

      SortedSet<IDbtModelColumn> getColumnDbtModelColumns()
      TBC
    • getColumnDepthLevel

      Integer getColumnDepthLevel()
      Level of nesting of this column, used for STRUCT and NESTED columns.
    • getColumnDistinctValuesCount

      Integer getColumnDistinctValuesCount()
      Number of rows that contain distinct values.
    • getColumnDistinctValuesCountLong

      Long getColumnDistinctValuesCountLong()
      Number of rows that contain distinct values.
    • getColumnDuplicateValuesCount

      Integer getColumnDuplicateValuesCount()
      Number of rows that contain duplicate values.
    • getColumnDuplicateValuesCountLong

      Long getColumnDuplicateValuesCountLong()
      Number of rows that contain duplicate values.
    • getColumnHierarchy

      List<Map<String,String>> getColumnHierarchy()
      List of top-level upstream nested columns.
    • getColumnHistogram

      Histogram getColumnHistogram()
      List of values in a histogram that represents the contents of this column.
    • getColumnMax

      Double getColumnMax()
      Greatest value in a numeric column.
    • getColumnMaximumStringLength

      Integer getColumnMaximumStringLength()
      Length of the longest value in a string column.
    • getColumnMaxs

      SortedSet<String> getColumnMaxs()
      List of the greatest values in a column.
    • getColumnMean

      Double getColumnMean()
      Arithmetic mean of the values in a numeric column.
    • getColumnMedian

      Double getColumnMedian()
      Calculated median of the values in a numeric column.
    • getColumnMin

      Double getColumnMin()
      Least value in a numeric column.
    • getColumnMinimumStringLength

      Integer getColumnMinimumStringLength()
      Length of the shortest value in a string column.
    • getColumnMins

      SortedSet<String> getColumnMins()
      List of the least values in a column.
    • getColumnMissingValuesCount

      Integer getColumnMissingValuesCount()
      Number of rows in a column that do not contain content.
    • getColumnMissingValuesCountLong

      Long getColumnMissingValuesCountLong()
      Number of rows in a column that do not contain content.
    • getColumnMissingValuesPercentage

      Double getColumnMissingValuesPercentage()
      Percentage of rows in a column that do not contain content.
    • getColumnStandardDeviation

      Double getColumnStandardDeviation()
      Calculated standard deviation of the values in a numeric column.
    • getColumnSum

      Double getColumnSum()
      Calculated sum of the values in a numeric column.
    • getColumnTopValues

      List<ColumnValueFrequencyMap> getColumnTopValues()
      List of top values in this column.
    • getColumnUniqueValuesCount

      Integer getColumnUniqueValuesCount()
      Number of rows in which a value in this column appears only once.
    • getColumnUniqueValuesCountLong

      Long getColumnUniqueValuesCountLong()
      Number of rows in which a value in this column appears only once.
    • getColumnUniquenessPercentage

      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.
    • getColumnVariance

      Double getColumnVariance()
      Calculated variance of the values in a numeric column.
    • getConnectionName

      String getConnectionName()
      Simple name of the connection through which this asset is accessible.
    • getConnectionQualifiedName

      String getConnectionQualifiedName()
      Unique name of the connection through which this asset is accessible.
    • getConnectorType

      AtlanConnectorType getConnectorType()
      Type of the connector through which this asset is accessible.
    • getCosmosMongoDBCollection

      ICosmosMongoDBCollection getCosmosMongoDBCollection()
      Cosmos collection in which this column exists.
    • getDataContractLatest

      IDataContract getDataContractLatest()
      Latest version of the data contract (in any status) for this asset.
    • getDataContractLatestCertified

      IDataContract getDataContractLatestCertified()
      Latest certified version of the data contract for this asset.
    • getDataQualityMetricDimensions

      SortedSet<IMetric> getDataQualityMetricDimensions()
      TBC
    • getDataType

      String getDataType()
      Data type of values in this column.
    • getDatabaseName

      String getDatabaseName()
      Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
    • getDatabaseQualifiedName

      String getDatabaseQualifiedName()
      Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
    • getDbtMetrics

      SortedSet<IDbtMetric> getDbtMetrics()
      TBC
    • getDbtModelColumns

      SortedSet<IDbtModelColumn> getDbtModelColumns()
      TBC
    • getDbtModels

      SortedSet<IDbtModel> getDbtModels()
      TBC
    • getDbtQualifiedName

      String getDbtQualifiedName()
      Unique name of this asset in dbt.
    • getDbtSources

      SortedSet<IDbtSource> getDbtSources()
      TBC
    • getDbtTests

      SortedSet<IDbtTest> getDbtTests()
      TBC
    • getDefaultValue

      String getDefaultValue()
      Default value for this column.
    • getDescription

      String getDescription()
      Description of this asset, for example as crawled from a source. Fallback for display purposes, if userDescription is empty.
    • getDisplayName

      String getDisplayName()
      Human-readable name of this asset used for display purposes (in user interface).
    • getDomainGUIDs

      SortedSet<String> getDomainGUIDs()
      Array of domain guids linked to this asset
    • getFiles

      SortedSet<IFile> getFiles()
      TBC
    • getForeignKeyFrom

      IColumn getForeignKeyFrom()
      Column this foreign key column refers to.
    • getForeignKeyTo

      SortedSet<IColumn> getForeignKeyTo()
      Columns that use this column as a foreign key.
    • getHasContract

      Boolean getHasContract()
      Whether this asset has contract (true) or not (false).
    • getHasLineage

      Boolean getHasLineage()
      Whether this asset has lineage (true) or not (false).
    • getInputPortDataProducts

      SortedSet<IDataProduct> getInputPortDataProducts()
      Data products for which this asset is an input port.
    • getInputToAirflowTasks

      SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
    • getInputToProcesses

      SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
    • getInputToSparkJobs

      SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
    • getIsAIGenerated

      Boolean getIsAIGenerated()
      TBC
    • getIsClustered

      Boolean getIsClustered()
      Whether this column is a clustered column (true) or not (false).
    • getIsDiscoverable

      Boolean getIsDiscoverable()
      Whether this asset is discoverable through the UI (true) or not (false).
    • getIsDist

      Boolean getIsDist()
      Whether this column is a distribution column (true) or not (false).
    • getIsEditable

      Boolean getIsEditable()
      Whether this asset can be edited in the UI (true) or not (false).
    • getIsForeign

      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.
    • getIsIndexed

      Boolean getIsIndexed()
      When true, this column is indexed in the database.
    • getIsNullable

      Boolean getIsNullable()
      When true, the values in this column can be null.
    • getIsPartial

      Boolean getIsPartial()
      TBC
    • getIsPartition

      Boolean getIsPartition()
      Whether this column is a partition column (true) or not (false).
    • getIsPinned

      Boolean getIsPinned()
      Whether this column is pinned (true) or not (false).
    • getIsPrimary

      Boolean getIsPrimary()
      When true, this column is the primary key for the table.
    • getIsProfiled

      Boolean getIsProfiled()
      Whether this asset has been profiled (true) or not (false).
    • getIsSort

      Boolean getIsSort()
      Whether this column is a sort column (true) or not (false).
    • getLastProfiledAt

      Long getLastProfiledAt()
      Time (epoch) at which this asset was last profiled, in milliseconds.
    • getLastRowChangedAt

      Long getLastRowChangedAt()
      Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.
    • getLastSyncRun

      String getLastSyncRun()
      Name of the last run of the crawler that last synchronized this asset.
    • getLastSyncRunAt

      Long getLastSyncRunAt()
      Time (epoch) at which this asset was last crawled, in milliseconds.
    • getLastSyncWorkflowName

      String getLastSyncWorkflowName()
      Name of the crawler that last synchronized this asset.
    • getLexicographicalSortOrder

      String getLexicographicalSortOrder()
      Custom order for sorting purpose, managed by client
    • getLinks

      SortedSet<ILink> getLinks()
      Links that are attached to this asset.
    • getMaterializedView

      IMaterializedView getMaterializedView()
      Materialized view in which this column exists.
    • getMaxLength

      Long getMaxLength()
      Maximum length of a value in this column.
    • getMcIncidents

      SortedSet<IMCIncident> getMcIncidents()
      TBC
    • getMcMonitors

      SortedSet<IMCMonitor> getMcMonitors()
      Monitors that observe this asset.
    • getMetricTimestamps

      SortedSet<IMetric> getMetricTimestamps()
      TBC
    • getMetrics

      SortedSet<IMetric> getMetrics()
      TBC
    • getModelImplementedEntities

      SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
    • getName

      String getName()
      Name of this asset. Fallback for display purposes, if displayName is empty.
    • getNestedColumnCount

      Integer getNestedColumnCount()
      Number of columns nested within this (STRUCT or NESTED) column.
    • getNestedColumnOrder

      String getNestedColumnOrder()
      Order (position) in which this column appears in the nested Column (nest level starts at 1).
    • getNestedColumns

      SortedSet<IColumn> getNestedColumns()
      Nested columns that exist within this column.
    • getNonCompliantAssetPolicyGUIDs

      SortedSet<String> getNonCompliantAssetPolicyGUIDs()
      Array of policy ids non-compliant to this asset
    • getNosqlCollectionName

      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.
    • getNosqlCollectionQualifiedName

      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.
    • getNumericScale

      Double getNumericScale()
      Number of digits allowed to the right of the decimal point.
    • getOrder

      Integer getOrder()
      Order (position) in which this column appears in the table (starting at 1).
    • getOutputFromAirflowTasks

      SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
    • getOutputFromProcesses

      SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
    • getOutputFromSparkJobs

      SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
    • getOutputPortDataProducts

      SortedSet<IDataProduct> getOutputPortDataProducts()
      Data products for which this asset is an output port.
    • getOwnerGroups

      SortedSet<String> getOwnerGroups()
      List of groups who own this asset.
    • getOwnerUsers

      SortedSet<String> getOwnerUsers()
      List of users who own this asset.
    • getParentColumn

      IColumn getParentColumn()
      Column in which this sub-column is nested.
    • getParentColumnName

      String getParentColumnName()
      Simple name of the column this column is nested within, for STRUCT and NESTED columns.
    • getParentColumnQualifiedName

      String getParentColumnQualifiedName()
      Unique name of the column this column is nested within, for STRUCT and NESTED columns.
    • getPartitionOrder

      Integer getPartitionOrder()
      Order (position) of this partition column in the table.
    • getPinnedAt

      Long getPinnedAt()
      Time (epoch) at which this column was pinned, in milliseconds.
    • getPinnedBy

      String getPinnedBy()
      User who pinned this column.
    • getPopularityScore

      Double getPopularityScore()
      Popularity score for this asset.
    • getPrecision

      Integer getPrecision()
      Total number of digits allowed, when the dataType is numeric.
    • getQualifiedName

      String getQualifiedName()
      Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName. This must be unique across all assets of the same type.
    • getQueries

      SortedSet<IAtlanQuery> getQueries()
      Queries that access this column.
    • getQueryCount

      Long getQueryCount()
      Number of times this asset has been queried.
    • getQueryCountUpdatedAt

      Long getQueryCountUpdatedAt()
      Time (epoch) at which the query count was last updated, in milliseconds.
    • getQueryUserCount

      Long getQueryUserCount()
      Number of unique users who have queried this asset.
    • getQueryUserMap

      Map<String,Long> getQueryUserMap()
      Map of unique users who have queried this asset to the number of times they have queried it.
    • getRawDataTypeDefinition

      String getRawDataTypeDefinition()
      TBC
    • getReadme

      IReadme getReadme()
      README that is linked to this asset.
    • getSampleDataUrl

      String getSampleDataUrl()
      URL for sample data for this asset.
    • getSchemaName

      String getSchemaName()
      Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
    • getSchemaQualifiedName

      String getSchemaQualifiedName()
      Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
    • getSchemaRegistrySubjects

      SortedSet<ISchemaRegistrySubject> getSchemaRegistrySubjects()
      TBC
    • getSnowflakeDynamicTable

      ISnowflakeDynamicTable getSnowflakeDynamicTable()
      Snowflake dynamic table in which this column exists.
    • getSodaChecks

      SortedSet<ISodaCheck> getSodaChecks()
      TBC
    • getSourceCostUnit

      SourceCostUnitType getSourceCostUnit()
      The unit of measure for sourceTotalCost.
    • getSourceCreatedAt

      Long getSourceCreatedAt()
      Time (epoch) at which this asset was created in the source system, in milliseconds.
    • getSourceCreatedBy

      String getSourceCreatedBy()
      Name of the user who created this asset, in the source system.
    • getSourceEmbedURL

      String getSourceEmbedURL()
      URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.
    • getSourceLastReadAt

      Long getSourceLastReadAt()
      Timestamp of most recent read operation.
    • getSourceOwners

      String getSourceOwners()
      List of owners of this asset, in the source system.
    • getSourceQueryComputeCostRecords

      List<PopularityInsights> getSourceQueryComputeCostRecords()
      List of most expensive warehouses with extra insights.
    • getSourceQueryComputeCosts

      SortedSet<String> getSourceQueryComputeCosts()
      List of most expensive warehouse names.
    • getSourceReadCount

      Long getSourceReadCount()
      Total count of all read operations at source.
    • getSourceReadExpensiveQueryRecords

      List<PopularityInsights> getSourceReadExpensiveQueryRecords()
      List of the most expensive queries that accessed this asset.
    • getSourceReadPopularQueryRecords

      List<PopularityInsights> getSourceReadPopularQueryRecords()
      List of the most popular queries that accessed this asset.
    • getSourceReadQueryCost

      Double getSourceReadQueryCost()
      Total cost of read queries at source.
    • getSourceReadRecentUserRecords

      List<PopularityInsights> getSourceReadRecentUserRecords()
      List of usernames with extra insights for the most recent users who read this asset.
    • getSourceReadRecentUsers

      SortedSet<String> getSourceReadRecentUsers()
      List of usernames of the most recent users who read this asset.
    • getSourceReadSlowQueryRecords

      List<PopularityInsights> getSourceReadSlowQueryRecords()
      List of the slowest queries that accessed this asset.
    • getSourceReadTopUserRecords

      List<PopularityInsights> getSourceReadTopUserRecords()
      List of usernames with extra insights for the users who read this asset the most.
    • getSourceReadTopUsers

      SortedSet<String> getSourceReadTopUsers()
      List of usernames of the users who read this asset the most.
    • getSourceReadUserCount

      Long getSourceReadUserCount()
      Total number of unique users that read data from asset.
    • getSourceTotalCost

      Double getSourceTotalCost()
      Total cost of all operations at source.
    • getSourceURL

      String getSourceURL()
      URL to the resource within the source application, used to create a button to view this asset in the source application.
    • getSourceUpdatedAt

      Long getSourceUpdatedAt()
      Time (epoch) at which this asset was last updated in the source system, in milliseconds.
    • getSourceUpdatedBy

      String getSourceUpdatedBy()
      Name of the user who last updated this asset, in the source system.
    • getSqlDBTSources

      SortedSet<IDbtSource> getSqlDBTSources()
      TBC
    • getSqlDbtModels

      SortedSet<IDbtModel> getSqlDbtModels()
      TBC
    • getStarredBy

      SortedSet<String> getStarredBy()
      Users who have starred this asset.
    • getStarredCount

      Integer getStarredCount()
      Number of users who have starred this asset.
    • getStarredDetails

      List<StarredDetails> getStarredDetails()
      List of usernames with extra information of the users who have starred an asset.
    • getSubDataType

      String getSubDataType()
      Sub-data type of this column.
    • getSubType

      String getSubType()
      Subtype of this asset.
    • getTable

      ITable getTable()
      Table in which this column exists.
    • getTableName

      String getTableName()
      Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
    • getTablePartition

      ITablePartition getTablePartition()
      Table partition that contains this column.
    • getTableQualifiedName

      String getTableQualifiedName()
      Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
    • getTenantId

      String getTenantId()
      Name of the Atlan workspace in which this asset exists.
    • getUserDefRelationshipFroms

      SortedSet<IAsset> getUserDefRelationshipFroms()
      TBC
    • getUserDefRelationshipTos

      SortedSet<IAsset> getUserDefRelationshipTos()
      TBC
    • getUserDescription

      String getUserDescription()
      Description of this asset, as provided by a user. If present, this will be used for the description in user interface.
    • getValidations

      Map<String,String> getValidations()
      Validations for this column.
    • getView

      IView getView()
      View in which this column exists.
    • getViewName

      String getViewName()
      Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
    • getViewQualifiedName

      String getViewQualifiedName()
      Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
    • getViewScore

      Double getViewScore()
      View score for this asset.
    • getViewerGroups

      SortedSet<String> getViewerGroups()
      List of groups who can view assets contained in a collection. (This is only used for certain asset types.)
    • getViewerUsers

      SortedSet<String> getViewerUsers()
      List of users who can view assets contained in a collection. (This is only used for certain asset types.)
    • getTypeName

      String getTypeName()
      Name of the type that defines the asset.
    • getGuid

      String getGuid()
      Globally-unique identifier for the asset.
    • getDisplayText

      String getDisplayText()
      Human-readable name of the asset.
    • getEntityStatus

      String getEntityStatus()
      Status of the asset (if this is a related asset).
    • getRelationshipType

      String getRelationshipType()
      Type of the relationship (if this is a related asset).
    • getRelationshipGuid

      String getRelationshipGuid()
      Unique identifier of the relationship (when this is a related asset).
    • getRelationshipStatus

      AtlanStatus getRelationshipStatus()
      Status of the relationship (when this is a related asset).
    • getRelationshipAttributes

      RelationshipAttributes getRelationshipAttributes()
      Attributes specific to the relationship (unused).
    • getUniqueAttributes

      UniqueAttributes getUniqueAttributes()
      Attribute(s) that uniquely identify the asset (when this is a related asset). If the guid is not provided, these must be provided.
    • isComplete

      boolean isComplete()
      When true, indicates that this object represents a complete view of the entity. When false, this object is only a reference or some partial view of the entity.
    • isValidReferenceByGuid

      boolean isValidReferenceByGuid()
      Indicates whether this object can be used as a valid reference by GUID.
      Returns:
      true if it is a valid GUID reference, false otherwise
    • isValidReferenceByQualifiedName

      boolean isValidReferenceByQualifiedName()
      Indicates whether this object can be used as a valid reference by qualifiedName.
      Returns:
      true if it is a valid qualifiedName reference, false otherwise