Package com.atlan.model.assets

Class Table.TableBuilder<C extends Table,B extends Table.TableBuilder<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.Table.TableBuilder<C,B>
Enclosing class:
Table
public abstract static class Table.TableBuilder<C extends Table,B extends Table.TableBuilder<C,B>> extends Asset.AssetBuilder<C,B>

  • Constructor Details

    • TableBuilder

      public TableBuilder()

  • Method Details

    • $fillValuesFrom

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

    • typeName

      public B typeName(String typeName)
      Fixed typeName for Tables.
      Overrides:
      typeName in class Reference.ReferenceBuilder<C extends Table,B extends Table.TableBuilder<C,B>>
      Returns:
      this.

    • alias

      public B alias(String alias)
      Alias for this table.
      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.

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

    • columnCount

      public B columnCount(Long columnCount)
      Number of columns in this table.
      Returns:
      this.

    • column

      public B column(IColumn column)

    • columns

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

    • clearColumns

      public B clearColumns()

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

    • 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()

    • dimension

      public B dimension(ITable dimension)

    • dimensions

      public B dimensions(Collection<? extends ITable> dimensions)

    • clearDimensions

      public B clearDimensions()

    • externalLocation

      public B externalLocation(String externalLocation)
      External location of this table, for example: an S3 object location.
      Returns:
      this.

    • externalLocationFormat

      public B externalLocationFormat(String externalLocationFormat)
      Format of the external location of this table, for example: JSON, CSV, PARQUET, etc.
      Returns:
      this.

    • externalLocationRegion

      public B externalLocationRegion(String externalLocationRegion)
      Region of the external location of this table, for example: S3 region.
      Returns:
      this.

    • fact

      public B fact(ITable fact)

    • facts

      public B facts(Collection<? extends ITable> facts)

    • clearFacts

      public B clearFacts()

    • icebergCatalogName

      public B icebergCatalogName(String icebergCatalogName)
      iceberg table catalog name (can be any user defined name)
      Returns:
      this.

    • icebergCatalogSource

      public B icebergCatalogSource(String icebergCatalogSource)
      iceberg table catalog type (glue, polaris, snowflake)
      Returns:
      this.

    • icebergCatalogTableName

      public B icebergCatalogTableName(String icebergCatalogTableName)
      catalog table name (actual table name on the catalog side).
      Returns:
      this.

    • icebergCatalogTableNamespace

      public B icebergCatalogTableNamespace(String icebergCatalogTableNamespace)
      catalog table namespace (actual database name on the catalog side).
      Returns:
      this.

    • icebergTableBaseLocation

      public B icebergTableBaseLocation(String icebergTableBaseLocation)
      iceberg table base location inside the external volume.
      Returns:
      this.

    • icebergTableType

      public B icebergTableType(String icebergTableType)
      iceberg table type (managed vs unmanaged)
      Returns:
      this.

    • 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()

    • isPartitioned

      public B isPartitioned(Boolean isPartitioned)
      Whether this table is partitioned (true) or not (false).
      Returns:
      this.

    • isProfiled

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

    • isQueryPreview

      public B isQueryPreview(Boolean isQueryPreview)
      Whether preview queries are allowed for this table (true) or not (false).
      Returns:
      this.

    • isSharded

      public B isSharded(Boolean isSharded)
      Whether this table is a sharded table (true) or not (false).
      Returns:
      this.

    • isTemporary

      public B isTemporary(Boolean isTemporary)
      Whether this table is temporary (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.

    • modelImplementedEntity

      public B modelImplementedEntity(IModelEntity modelImplementedEntity)

    • modelImplementedEntities

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

    • clearModelImplementedEntities

      public B clearModelImplementedEntities()

    • 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()

    • partitionCount

      public B partitionCount(Long partitionCount)
      Number of partitions in this table.
      Returns:
      this.

    • partitionList

      public B partitionList(String partitionList)
      List of partitions in this table.
      Returns:
      this.

    • partitionStrategy

      public B partitionStrategy(String partitionStrategy)
      Partition strategy for this table.
      Returns:
      this.

    • partition

      public B partition(ITablePartition partition)

    • partitions

      public B partitions(Collection<? extends ITablePartition> partitions)

    • clearPartitions

      public B clearPartitions()

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

    • putQueryPreviewConfig

      public B putQueryPreviewConfig(String putQueryPreviewConfigKey, String putQueryPreviewConfigValue)

    • queryPreviewConfig

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

    • clearQueryPreviewConfig

      public B clearQueryPreviewConfig()

    • 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()

    • rowCount

      public B rowCount(Long rowCount)
      Number of rows in this table.
      Returns:
      this.

    • schema

      public B schema(ISchema schema)
      Schema in which this table exists.
      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.

    • sizeBytes

      public B sizeBytes(Long sizeBytes)
      Size of this table, in bytes.
      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()

    • tableExternalVolumeName

      public B tableExternalVolumeName(String tableExternalVolumeName)
      external volume name for the table.
      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.

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

    • tableRetentionTime

      public B tableRetentionTime(Long tableRetentionTime)
      Data retention time in days.
      Returns:
      this.

    • tableType

      public B tableType(TableType tableType)
      Type of the table.
      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 Table,B extends Table.TableBuilder<C,B>>

    • build

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

    • toString

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