Package com.atlan.model.assets

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

  • Constructor Details

    • AtlanQueryBuilder

      public AtlanQueryBuilder()

  • Method Details

    • withRawQuery

      public B withRawQuery(String schemaQualifiedName, String query)

    • $fillValuesFrom

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

    • typeName

      public B typeName(String typeName)
      Fixed typeName for AtlanQuerys.
      Overrides:
      typeName in class Reference.ReferenceBuilder<C extends AtlanQuery,B extends AtlanQuery.AtlanQueryBuilder<C,B>>
      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.

    • collectionQualifiedName

      public B collectionQualifiedName(String collectionQualifiedName)
      Unique name of the collection in which this query exists.
      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()

    • dbtSeedAsset

      public B dbtSeedAsset(IDbtSeed dbtSeedAsset)

    • dbtSeedAssets

      public B dbtSeedAssets(Collection<? extends IDbtSeed> dbtSeedAssets)

    • clearDbtSeedAssets

      public B clearDbtSeedAssets()

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

    • defaultDatabaseQualifiedName

      public B defaultDatabaseQualifiedName(String defaultDatabaseQualifiedName)
      Unique name of the default database to use for this query.
      Returns:
      this.

    • defaultSchemaQualifiedName

      public B defaultSchemaQualifiedName(String defaultSchemaQualifiedName)
      Unique name of the default schema to use for this query.
      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()

    • isPrivate

      public B isPrivate(Boolean isPrivate)
      Whether this query is private (true) or shared (false).
      Returns:
      this.

    • isProfiled

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

    • isSqlSnippet

      public B isSqlSnippet(Boolean isSqlSnippet)
      Whether this query is a SQL snippet (true) or not (false).
      Returns:
      this.

    • isVisualQuery

      public B isVisualQuery(Boolean isVisualQuery)
      Whether this query is a visual query (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.

    • longRawQuery

      public B longRawQuery(String longRawQuery)
      Raw SQL query string.
      Returns:
      this.

    • modelImplementedAttribute

      public B modelImplementedAttribute(IModelAttribute modelImplementedAttribute)

    • modelImplementedAttributes

      public B modelImplementedAttributes(Collection<? extends IModelAttribute> modelImplementedAttributes)

    • clearModelImplementedAttributes

      public B clearModelImplementedAttributes()

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

    • parent

      public B parent(INamespace parent)
      Namespace in which this query exists.
      Returns:
      this.

    • parentQualifiedName

      public B parentQualifiedName(String parentQualifiedName)
      Unique name of the parent collection or folder in which this query exists.
      Returns:
      this.

    • partialChildField

      public B partialChildField(IPartialField partialChildField)

    • partialChildFields

      public B partialChildFields(Collection<? extends IPartialField> partialChildFields)

    • clearPartialChildFields

      public B clearPartialChildFields()

    • partialChildObject

      public B partialChildObject(IPartialObject partialChildObject)

    • partialChildObjects

      public B partialChildObjects(Collection<? extends IPartialObject> partialChildObjects)

    • clearPartialChildObjects

      public B clearPartialChildObjects()

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

    • rawQuery

      public B rawQuery(String rawQuery)
      Deprecated. See 'longRawQuery' instead.
      Returns:
      this.

    • rawQueryText

      public B rawQueryText(String rawQueryText)
      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.

    • snowflakeSemanticLogicalTable

      public B snowflakeSemanticLogicalTable(ISnowflakeSemanticLogicalTable snowflakeSemanticLogicalTable)

    • snowflakeSemanticLogicalTables

      public B snowflakeSemanticLogicalTables(Collection<? extends ISnowflakeSemanticLogicalTable> snowflakeSemanticLogicalTables)

    • clearSnowflakeSemanticLogicalTables

      public B clearSnowflakeSemanticLogicalTables()

    • sqlAIModelContextQualifiedName

      public B sqlAIModelContextQualifiedName(String sqlAIModelContextQualifiedName)
      Unique name of the context in which the model versions exist, or empty if it does not exist within an AI model context.
      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()

    • sqlIsSecure

      public B sqlIsSecure(Boolean sqlIsSecure)
      Whether this asset is secure (true) or not (false).
      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.

    • table

      public B table(ITable table)

    • tables

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

    • clearTables

      public B clearTables()

    • variablesSchemaBase64

      public B variablesSchemaBase64(String variablesSchemaBase64)
      Base64-encoded string of the variables to use in this query.
      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.

    • view

      public B view(IView view)

    • views

      public B views(Collection<? extends IView> views)

    • clearViews

      public B clearViews()

    • visualBuilderSchemaBase64

      public B visualBuilderSchemaBase64(String visualBuilderSchemaBase64)
      Base64-encoded string for the visual query builder.
      Returns:
      this.

    • self

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

    • build

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

    • toString

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