Skip to main content

DataPoolSetupTask

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

fields

  • name non-null String

    The name of the Data Pool Setup Task to be performed.

  • description nullable String

    A description of the Data Pool Setup Task to be performed.

  • status non-null DataPoolSetupTaskStatus

    The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

    The status of a Data Pool Setup Task.

    • NOT_STARTED

      The Data Pool Setup Task has not been started yet.

    • SUCCEEDED

      The Data Pool Setup Task has completed successfully.

    • FAILED

      The Data Pool Setup Task has failed.

  • error nullable Error

    If the Data Pool Setup Task failed, this field includes a descriptive error message.

    The error object.

  • completedAt nullable DateTime

    The time at which the Data Pool Setup Task was completed.