Package com.atlan.model.assets

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

  • Constructor Details

    • ConnectionBuilder

      public ConnectionBuilder()

  • Method Details

    • $fillValuesFrom

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

    • typeName

      public B typeName(String typeName)
      Fixed typeName for Connections.
      Overrides:
      typeName in class Reference.ReferenceBuilder<C extends Connection,B extends Connection.ConnectionBuilder<C,B>>
      Returns:
      this.

    • allowQuery

      public B allowQuery(Boolean allowQuery)
      Whether using this connection to run queries on the source is allowed (true) or not (false).
      Returns:
      this.

    • allowQueryPreview

      public B allowQueryPreview(Boolean allowQueryPreview)
      Whether using this connection to run preview queries on the source is allowed (true) or not (false).
      Returns:
      this.

    • category

      public B category(AtlanConnectionCategory category)
      Type of connection, for example WAREHOUSE, RDBMS, etc.
      Returns:
      this.

    • connectionDQCredentialGuid

      public B connectionDQCredentialGuid(String connectionDQCredentialGuid)
      Unique identifier (GUID) for the data quality credentials to use for this connection.
      Returns:
      this.

    • connectionDQEnvironmentSetupErrorMessage

      public B connectionDQEnvironmentSetupErrorMessage(String connectionDQEnvironmentSetupErrorMessage)
      Error message if data quality environment setup failed for this connection.
      Returns:
      this.

    • connectionDQEnvironmentSetupStatus

      public B connectionDQEnvironmentSetupStatus(ConnectionDQEnvironmentSetupStatus connectionDQEnvironmentSetupStatus)
      Status of the data quality environment setup for this connection.
      Returns:
      this.

    • connectionDQEnvironmentSetupStatusUpdatedAt

      public B connectionDQEnvironmentSetupStatusUpdatedAt(Long connectionDQEnvironmentSetupStatusUpdatedAt)
      Timestamp when the data quality environment setup status was last updated.
      Returns:
      this.

    • connectionDQEnvironmentSourceDatabaseName

      public B connectionDQEnvironmentSourceDatabaseName(String connectionDQEnvironmentSourceDatabaseName)
      Name of the database in the source environment for data quality.
      Returns:
      this.

    • connectionDbtEnvironment

      public B connectionDbtEnvironment(String connectionDbtEnvironment)

    • connectionDbtEnvironments

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

    • clearConnectionDbtEnvironments

      public B clearConnectionDbtEnvironments()

    • connectionIsDQEnabled

      public B connectionIsDQEnabled(Boolean connectionIsDQEnabled)
      Whether data quality is enabled for this connection (true) or not (false).
      Returns:
      this.

    • connectionSSOCredentialGuid

      public B connectionSSOCredentialGuid(String connectionSSOCredentialGuid)
      Unique identifier (GUID) for the SSO credentials to use for this connection.
      Returns:
      this.

    • putConnectionWorkflowConfiguration

      public B putConnectionWorkflowConfiguration(String putConnectionWorkflowConfigurationKey, String putConnectionWorkflowConfigurationValue)

    • connectionWorkflowConfiguration

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

    • clearConnectionWorkflowConfiguration

      public B clearConnectionWorkflowConfiguration()

    • connectorIcon

      public B connectorIcon(String connectorIcon)
      Unused. Only the value of connectorType impacts icons.
      Returns:
      this.

    • connectorImage

      public B connectorImage(String connectorImage)
      Unused. Only the value of connectorType impacts icons.
      Returns:
      this.

    • credentialStrategy

      public B credentialStrategy(String credentialStrategy)
      Credential strategy to use for this connection for queries.
      Returns:
      this.

    • defaultCredentialGuid

      public B defaultCredentialGuid(String defaultCredentialGuid)
      Unique identifier (GUID) for the default credentials to use for this connection.
      Returns:
      this.

    • hasPopularityInsights

      public B hasPopularityInsights(Boolean hasPopularityInsights)
      Whether this connection has popularity insights (true) or not (false).
      Returns:
      this.

    • host

      public B host(String host)
      Host name of this connection's source.
      Returns:
      this.

    • inputToConnectionProcess

      public B inputToConnectionProcess(IConnectionProcess inputToConnectionProcess)

    • inputToConnectionProcesses

      public B inputToConnectionProcesses(Collection<? extends IConnectionProcess> inputToConnectionProcesses)

    • clearInputToConnectionProcesses

      public B clearInputToConnectionProcesses()

    • isSampleDataPreviewEnabled

      public B isSampleDataPreviewEnabled(Boolean isSampleDataPreviewEnabled)
      Whether sample data can be previewed for this connection (true) or not (false).
      Returns:
      this.

    • objectStorageUploadThreshold

      public B objectStorageUploadThreshold(Long objectStorageUploadThreshold)
      Number of rows after which results should be uploaded to storage.
      Returns:
      this.

    • outputFromConnectionProcess

      public B outputFromConnectionProcess(IConnectionProcess outputFromConnectionProcess)

    • outputFromConnectionProcesses

      public B outputFromConnectionProcesses(Collection<? extends IConnectionProcess> outputFromConnectionProcesses)

    • clearOutputFromConnectionProcesses

      public B clearOutputFromConnectionProcesses()

    • policyStrategy

      public B policyStrategy(String policyStrategy)
      Policy strategy is a configuration that determines whether the Atlan policy will be applied to the results of insight queries and whether the query will be rewritten, applicable for stream api call made from insight screen
      Returns:
      this.

    • policyStrategyForSamplePreview

      public B policyStrategyForSamplePreview(String policyStrategyForSamplePreview)
      Policy strategy is a configuration that determines whether the Atlan policy will be applied to the results of insight queries and whether the query will be rewritten. policyStrategyForSamplePreview config is applicable for sample preview call from assets screen
      Returns:
      this.

    • popularityInsightsTimeframe

      public B popularityInsightsTimeframe(Long popularityInsightsTimeframe)
      Number of days over which popularity is calculated, for example 30 days.
      Returns:
      this.

    • port

      public B port(Integer port)
      Port number to this connection's source.
      Returns:
      this.

    • previewCredentialStrategy

      public B previewCredentialStrategy(String previewCredentialStrategy)
      Credential strategy to use for this connection for preview queries.
      Returns:
      this.

    • queryConfig

      public B queryConfig(String queryConfig)
      Query config for this connection.
      Returns:
      this.

    • putQueryPreviewConfig

      public B putQueryPreviewConfig(String putQueryPreviewConfigKey, String putQueryPreviewConfigValue)

    • queryPreviewConfig

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

    • clearQueryPreviewConfig

      public B clearQueryPreviewConfig()

    • queryTimeout

      public B queryTimeout(Long queryTimeout)
      Maximum time a query should be allowed to run before timing out.
      Returns:
      this.

    • queryUsernameStrategy

      public B queryUsernameStrategy(QueryUsernameStrategy queryUsernameStrategy)
      Username strategy to use for this connection for queries.
      Returns:
      this.

    • rowLimit

      public B rowLimit(Long rowLimit)
      Maximum number of rows that can be returned for the source.
      Returns:
      this.

    • sourceLogo

      public B sourceLogo(String sourceLogo)
      Unused. Only the value of connectorType impacts icons.
      Returns:
      this.

    • subCategory

      public B subCategory(String subCategory)
      Subcategory of this connection.
      Returns:
      this.

    • useObjectStorage

      public B useObjectStorage(Boolean useObjectStorage)
      Whether to upload to S3, GCP, or another storage location (true) or not (false).
      Returns:
      this.

    • vectorEmbeddingsEnabled

      public B vectorEmbeddingsEnabled(Boolean vectorEmbeddingsEnabled)
      TBC
      Returns:
      this.

    • vectorEmbeddingsUpdatedAt

      public B vectorEmbeddingsUpdatedAt(Long vectorEmbeddingsUpdatedAt)
      TBC
      Returns:
      this.

    • self

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

    • build

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

    • toString

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