Package com.atlan.model.assets

Class Column.ColumnBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>>

java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.relations.Reference.ReferenceBuilder<C,B>
com.atlan.model.assets.Asset.AssetBuilder<C,B>
com.atlan.model.assets.Column.ColumnBuilder<C,B>
Enclosing class:
Column
public abstract static class Column.ColumnBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>> extends Asset.AssetBuilder<C,B>

  • Constructor Details

    • ColumnBuilder

      public ColumnBuilder()

  • Method Details

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class Asset.AssetBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>>

    • typeName

      public B typeName(String typeName)
      Fixed typeName for Columns.
      Overrides:
      typeName in class Reference.ReferenceBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>>
      Returns:
      this.

    • applicationContainer

      public B applicationContainer(IApplicationContainer applicationContainer)
      ApplicationContainer asset containing this Catalog asset.
      Returns:
      this.

    • assetApplicationQualifiedName

      public B assetApplicationQualifiedName(String assetApplicationQualifiedName)
      Qualified name of the Application Container that contains this asset.
      Returns:
      this.

    • calculationView

      public B calculationView(ICalculationView calculationView)
      Calculate view in which this column exists.
      Returns:
      this.

    • calculationViewName

      public B calculationViewName(String calculationViewName)
      Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
      Returns:
      this.

    • calculationViewQualifiedName

      public B calculationViewQualifiedName(String calculationViewQualifiedName)
      Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
      Returns:
      this.

    • columnAverage

      public B columnAverage(Double columnAverage)
      Average value in this column.
      Returns:
      this.

    • columnAverageLength

      public B columnAverageLength(Double columnAverageLength)
      Average length of values in a string column.
      Returns:
      this.

    • columnDbtModelColumn

      public B columnDbtModelColumn(IDbtModelColumn columnDbtModelColumn)

    • columnDbtModelColumns

      public B columnDbtModelColumns(Collection<? extends IDbtModelColumn> columnDbtModelColumns)

    • clearColumnDbtModelColumns

      public B clearColumnDbtModelColumns()

    • columnDepthLevel

      public B columnDepthLevel(Integer columnDepthLevel)
      Level of nesting of this column, used for STRUCT and NESTED columns.
      Returns:
      this.

    • columnDistinctValuesCount

      public B columnDistinctValuesCount(Integer columnDistinctValuesCount)
      Number of rows that contain distinct values.
      Returns:
      this.

    • columnDistinctValuesCountLong

      public B columnDistinctValuesCountLong(Long columnDistinctValuesCountLong)
      Number of rows that contain distinct values.
      Returns:
      this.

    • columnDuplicateValuesCount

      public B columnDuplicateValuesCount(Integer columnDuplicateValuesCount)
      Number of rows that contain duplicate values.
      Returns:
      this.

    • columnDuplicateValuesCountLong

      public B columnDuplicateValuesCountLong(Long columnDuplicateValuesCountLong)
      Number of rows that contain duplicate values.
      Returns:
      this.

    • putColumnHierarchy

      public B putColumnHierarchy(Map<String,String> putColumnHierarchy)

    • columnHierarchy

      public B columnHierarchy(Collection<? extends Map<String,String>> columnHierarchy)

    • clearColumnHierarchy

      public B clearColumnHierarchy()

    • columnHistogram

      public B columnHistogram(Histogram columnHistogram)
      List of values in a histogram that represents the contents of this column.
      Returns:
      this.

    • columnMax

      public B columnMax(Double columnMax)
      Greatest value in a numeric column.
      Returns:
      this.

    • columnMaximumStringLength

      public B columnMaximumStringLength(Integer columnMaximumStringLength)
      Length of the longest value in a string column.
      Returns:
      this.

    • addColumnMax

      public B addColumnMax(String addColumnMax)

    • columnMaxs

      public B columnMaxs(Collection<? extends String> columnMaxs)

    • clearColumnMaxs

      public B clearColumnMaxs()

    • columnMean

      public B columnMean(Double columnMean)
      Arithmetic mean of the values in a numeric column.
      Returns:
      this.

    • columnMedian

      public B columnMedian(Double columnMedian)
      Calculated median of the values in a numeric column.
      Returns:
      this.

    • columnMin

      public B columnMin(Double columnMin)
      Least value in a numeric column.
      Returns:
      this.

    • columnMinimumStringLength

      public B columnMinimumStringLength(Integer columnMinimumStringLength)
      Length of the shortest value in a string column.
      Returns:
      this.

    • addColumnMin

      public B addColumnMin(String addColumnMin)

    • columnMins

      public B columnMins(Collection<? extends String> columnMins)

    • clearColumnMins

      public B clearColumnMins()

    • columnMissingValuesCount

      public B columnMissingValuesCount(Integer columnMissingValuesCount)
      Number of rows in a column that do not contain content.
      Returns:
      this.

    • columnMissingValuesCountLong

      public B columnMissingValuesCountLong(Long columnMissingValuesCountLong)
      Number of rows in a column that do not contain content.
      Returns:
      this.

    • columnMissingValuesPercentage

      public B columnMissingValuesPercentage(Double columnMissingValuesPercentage)
      Percentage of rows in a column that do not contain content.
      Returns:
      this.

    • columnStandardDeviation

      public B columnStandardDeviation(Double columnStandardDeviation)
      Calculated standard deviation of the values in a numeric column.
      Returns:
      this.

    • columnSum

      public B columnSum(Double columnSum)
      Calculated sum of the values in a numeric column.
      Returns:
      this.

    • columnTopValue

      public B columnTopValue(ColumnValueFrequencyMap columnTopValue)

    • columnTopValues

      public B columnTopValues(Collection<? extends ColumnValueFrequencyMap> columnTopValues)

    • clearColumnTopValues

      public B clearColumnTopValues()

    • columnUniqueValuesCount

      public B columnUniqueValuesCount(Integer columnUniqueValuesCount)
      Number of rows in which a value in this column appears only once.
      Returns:
      this.

    • columnUniqueValuesCountLong

      public B columnUniqueValuesCountLong(Long columnUniqueValuesCountLong)
      Number of rows in which a value in this column appears only once.
      Returns:
      this.

    • columnUniquenessPercentage

      public B columnUniquenessPercentage(Double columnUniquenessPercentage)
      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.
      Returns:
      this.

    • columnVariance

      public B columnVariance(Double columnVariance)
      Calculated variance of the values in a numeric column.
      Returns:
      this.

    • cosmosMongoDBCollection

      public B cosmosMongoDBCollection(ICosmosMongoDBCollection cosmosMongoDBCollection)
      Cosmos collection in which this column exists.
      Returns:
      this.

    • dataQualityMetricDimension

      public B dataQualityMetricDimension(IMetric dataQualityMetricDimension)

    • dataQualityMetricDimensions

      public B dataQualityMetricDimensions(Collection<? extends IMetric> dataQualityMetricDimensions)

    • clearDataQualityMetricDimensions

      public B clearDataQualityMetricDimensions()

    • dataType

      public B dataType(String dataType)
      Data type of values in this column.
      Returns:
      this.

    • databaseName

      public B databaseName(String databaseName)
      Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
      Returns:
      this.

    • databaseQualifiedName

      public B databaseQualifiedName(String databaseQualifiedName)
      Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
      Returns:
      this.

    • dbtMetric

      public B dbtMetric(IDbtMetric dbtMetric)

    • dbtMetrics

      public B dbtMetrics(Collection<? extends IDbtMetric> dbtMetrics)

    • clearDbtMetrics

      public B clearDbtMetrics()

    • dbtModelColumn

      public B dbtModelColumn(IDbtModelColumn dbtModelColumn)

    • dbtModelColumns

      public B dbtModelColumns(Collection<? extends IDbtModelColumn> dbtModelColumns)

    • clearDbtModelColumns

      public B clearDbtModelColumns()

    • dbtModel

      public B dbtModel(IDbtModel dbtModel)

    • dbtModels

      public B dbtModels(Collection<? extends IDbtModel> dbtModels)

    • clearDbtModels

      public B clearDbtModels()

    • dbtSource

      public B dbtSource(IDbtSource dbtSource)

    • dbtSources

      public B dbtSources(Collection<? extends IDbtSource> dbtSources)

    • clearDbtSources

      public B clearDbtSources()

    • dbtTest

      public B dbtTest(IDbtTest dbtTest)

    • dbtTests

      public B dbtTests(Collection<? extends IDbtTest> dbtTests)

    • clearDbtTests

      public B clearDbtTests()

    • defaultValue

      public B defaultValue(String defaultValue)
      Default value for this column.
      Returns:
      this.

    • foreignKeyFrom

      public B foreignKeyFrom(IColumn foreignKeyFrom)
      Column this foreign key column refers to.
      Returns:
      this.

    • addForeignKeyTo

      public B addForeignKeyTo(IColumn addForeignKeyTo)

    • foreignKeyTo

      public B foreignKeyTo(Collection<? extends IColumn> foreignKeyTo)

    • clearForeignKeyTo

      public B clearForeignKeyTo()

    • inputToAirflowTask

      public B inputToAirflowTask(IAirflowTask inputToAirflowTask)

    • inputToAirflowTasks

      public B inputToAirflowTasks(Collection<? extends IAirflowTask> inputToAirflowTasks)

    • clearInputToAirflowTasks

      public B clearInputToAirflowTasks()

    • inputToProcess

      public B inputToProcess(ILineageProcess inputToProcess)

    • inputToProcesses

      public B inputToProcesses(Collection<? extends ILineageProcess> inputToProcesses)

    • clearInputToProcesses

      public B clearInputToProcesses()

    • inputToSparkJob

      public B inputToSparkJob(ISparkJob inputToSparkJob)

    • inputToSparkJobs

      public B inputToSparkJobs(Collection<? extends ISparkJob> inputToSparkJobs)

    • clearInputToSparkJobs

      public B clearInputToSparkJobs()

    • isClustered

      public B isClustered(Boolean isClustered)
      Whether this column is a clustered column (true) or not (false).
      Returns:
      this.

    • isDist

      public B isDist(Boolean isDist)
      Whether this column is a distribution column (true) or not (false).
      Returns:
      this.

    • isForeign

      public B isForeign(Boolean isForeign)
      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.
      Returns:
      this.

    • isIndexed

      public B isIndexed(Boolean isIndexed)
      When true, this column is indexed in the database.
      Returns:
      this.

    • isNullable

      public B isNullable(Boolean isNullable)
      When true, the values in this column can be null.
      Returns:
      this.

    • isPartition

      public B isPartition(Boolean isPartition)
      Whether this column is a partition column (true) or not (false).
      Returns:
      this.

    • isPinned

      public B isPinned(Boolean isPinned)
      Whether this column is pinned (true) or not (false).
      Returns:
      this.

    • isPrimary

      public B isPrimary(Boolean isPrimary)
      When true, this column is the primary key for the table.
      Returns:
      this.

    • isProfiled

      public B isProfiled(Boolean isProfiled)
      Whether this asset has been profiled (true) or not (false).
      Returns:
      this.

    • isSort

      public B isSort(Boolean isSort)
      Whether this column is a sort column (true) or not (false).
      Returns:
      this.

    • lastProfiledAt

      public B lastProfiledAt(Long lastProfiledAt)
      Time (epoch) at which this asset was last profiled, in milliseconds.
      Returns:
      this.

    • materializedView

      public B materializedView(IMaterializedView materializedView)
      Materialized view in which this column exists.
      Returns:
      this.

    • maxLength

      public B maxLength(Long maxLength)
      Maximum length of a value in this column.
      Returns:
      this.

    • metricTimestamp

      public B metricTimestamp(IMetric metricTimestamp)

    • metricTimestamps

      public B metricTimestamps(Collection<? extends IMetric> metricTimestamps)

    • clearMetricTimestamps

      public B clearMetricTimestamps()

    • modelImplementedEntity

      public B modelImplementedEntity(IModelEntity modelImplementedEntity)

    • modelImplementedEntities

      public B modelImplementedEntities(Collection<? extends IModelEntity> modelImplementedEntities)

    • clearModelImplementedEntities

      public B clearModelImplementedEntities()

    • nestedColumnCount

      public B nestedColumnCount(Integer nestedColumnCount)
      Number of columns nested within this (STRUCT or NESTED) column.
      Returns:
      this.

    • nestedColumnOrder

      public B nestedColumnOrder(String nestedColumnOrder)
      Order (position) in which this column appears in the nested Column (nest level starts at 1).
      Returns:
      this.

    • nestedColumn

      public B nestedColumn(IColumn nestedColumn)

    • nestedColumns

      public B nestedColumns(Collection<? extends IColumn> nestedColumns)

    • clearNestedColumns

      public B clearNestedColumns()

    • nosqlCollectionName

      public B nosqlCollectionName(String nosqlCollectionName)
      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.
      Returns:
      this.

    • nosqlCollectionQualifiedName

      public B nosqlCollectionQualifiedName(String nosqlCollectionQualifiedName)
      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.
      Returns:
      this.

    • numericScale

      public B numericScale(Double numericScale)
      Number of digits allowed to the right of the decimal point.
      Returns:
      this.

    • order

      public B order(Integer order)
      Order (position) in which this column appears in the table (starting at 1).
      Returns:
      this.

    • outputFromAirflowTask

      public B outputFromAirflowTask(IAirflowTask outputFromAirflowTask)

    • outputFromAirflowTasks

      public B outputFromAirflowTasks(Collection<? extends IAirflowTask> outputFromAirflowTasks)

    • clearOutputFromAirflowTasks

      public B clearOutputFromAirflowTasks()

    • outputFromProcess

      public B outputFromProcess(ILineageProcess outputFromProcess)

    • outputFromProcesses

      public B outputFromProcesses(Collection<? extends ILineageProcess> outputFromProcesses)

    • clearOutputFromProcesses

      public B clearOutputFromProcesses()

    • outputFromSparkJob

      public B outputFromSparkJob(ISparkJob outputFromSparkJob)

    • outputFromSparkJobs

      public B outputFromSparkJobs(Collection<? extends ISparkJob> outputFromSparkJobs)

    • clearOutputFromSparkJobs

      public B clearOutputFromSparkJobs()

    • parentColumn

      public B parentColumn(IColumn parentColumn)
      Column in which this sub-column is nested.
      Returns:
      this.

    • parentColumnName

      public B parentColumnName(String parentColumnName)
      Simple name of the column this column is nested within, for STRUCT and NESTED columns.
      Returns:
      this.

    • parentColumnQualifiedName

      public B parentColumnQualifiedName(String parentColumnQualifiedName)
      Unique name of the column this column is nested within, for STRUCT and NESTED columns.
      Returns:
      this.

    • partitionOrder

      public B partitionOrder(Integer partitionOrder)
      Order (position) of this partition column in the table.
      Returns:
      this.

    • pinnedAt

      public B pinnedAt(Long pinnedAt)
      Time (epoch) at which this column was pinned, in milliseconds.
      Returns:
      this.

    • pinnedBy

      public B pinnedBy(String pinnedBy)
      User who pinned this column.
      Returns:
      this.

    • precision

      public B precision(Integer precision)
      Total number of digits allowed, when the dataType is numeric.
      Returns:
      this.

    • query

      public B query(IAtlanQuery query)

    • queries

      public B queries(Collection<? extends IAtlanQuery> queries)

    • clearQueries

      public B clearQueries()

    • queryCount

      public B queryCount(Long queryCount)
      Number of times this asset has been queried.
      Returns:
      this.

    • queryCountUpdatedAt

      public B queryCountUpdatedAt(Long queryCountUpdatedAt)
      Time (epoch) at which the query count was last updated, in milliseconds.
      Returns:
      this.

    • queryUserCount

      public B queryUserCount(Long queryUserCount)
      Number of unique users who have queried this asset.
      Returns:
      this.

    • putQueryUserMap

      public B putQueryUserMap(String putQueryUserMapKey, Long putQueryUserMapValue)

    • queryUserMap

      public B queryUserMap(Map<? extends String,? extends Long> queryUserMap)

    • clearQueryUserMap

      public B clearQueryUserMap()

    • rawDataTypeDefinition

      public B rawDataTypeDefinition(String rawDataTypeDefinition)
      TBC
      Returns:
      this.

    • schemaName

      public B schemaName(String schemaName)
      Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
      Returns:
      this.

    • schemaQualifiedName

      public B schemaQualifiedName(String schemaQualifiedName)
      Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
      Returns:
      this.

    • snowflakeDynamicTable

      public B snowflakeDynamicTable(ISnowflakeDynamicTable snowflakeDynamicTable)
      Snowflake dynamic table in which this column exists.
      Returns:
      this.

    • sqlDBTSource

      public B sqlDBTSource(IDbtSource sqlDBTSource)

    • sqlDBTSources

      public B sqlDBTSources(Collection<? extends IDbtSource> sqlDBTSources)

    • clearSqlDBTSources

      public B clearSqlDBTSources()

    • sqlDbtModel

      public B sqlDbtModel(IDbtModel sqlDbtModel)

    • sqlDbtModels

      public B sqlDbtModels(Collection<? extends IDbtModel> sqlDbtModels)

    • clearSqlDbtModels

      public B clearSqlDbtModels()

    • subDataType

      public B subDataType(String subDataType)
      Sub-data type of this column.
      Returns:
      this.

    • table

      public B table(ITable table)
      Table in which this column exists.
      Returns:
      this.

    • tableName

      public B tableName(String tableName)
      Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
      Returns:
      this.

    • tablePartition

      public B tablePartition(ITablePartition tablePartition)
      Table partition that contains this column.
      Returns:
      this.

    • tableQualifiedName

      public B tableQualifiedName(String tableQualifiedName)
      Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
      Returns:
      this.

    • validation

      public B validation(String validationKey, String validationValue)

    • validations

      public B validations(Map<? extends String,? extends String> validations)

    • clearValidations

      public B clearValidations()

    • view

      public B view(IView view)
      View in which this column exists.
      Returns:
      this.

    • viewName

      public B viewName(String viewName)
      Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
      Returns:
      this.

    • viewQualifiedName

      public B viewQualifiedName(String viewQualifiedName)
      Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class Asset.AssetBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class Asset.AssetBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class Asset.AssetBuilder<C extends Column,B extends Column.ColumnBuilder<C,B>>