.. _auto_sleep:

*SLEEP WORKER*
==============

Pauses workflow execution for a specified number of seconds, then reports the elapsed sleep duration. Use this worker to introduce deliberate delays between pipeline steps, throttle job submission rates, or simulate latency in testing scenarios.

When to use
-----------

Tagged: ``delay``, ``pause``, ``sleep``, ``testing``, ``throttle``, ``wait``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Name
     - name
     - text
     - —
     - ✓
     - Human-readable label for this sleep step; used for identification in workflow logs and UI — any non-empty string is valid.
   * - Duration
     - duration
     - text
     - 1
     - ✓
     - Number of seconds the worker will sleep before continuing; must be a positive integer (default: 1).

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Slept
     - slept
     - integer
     - Integer number of seconds actually slept, echoing back the requested duration value upon successful completion.

Disciplines
-----------

- platform.job_submission
- platform.workflow

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>sleep</code>. Schema hash: <code>275ca5b42654</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>