Skip to content

TaskContainerDependency

Source code in docs_src/capo_batch/types/task_container_dependency.py
class TaskContainerDependency(TypedDict, closed=True):
    container_name: NotRequired["capo_batch.types.string.String"]
    """<p>A unique identifier for the container.</p>"""
    condition: NotRequired["capo_batch.types.string.String"]
    """<p>The dependency condition of the container. The following are the available conditions and their behavior:</p> <ul> <li> <p> <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. </p> </li> <li> <p> <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. </p> </li> <li> <p> <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the container exits with a zero status. This condition can't be set on an essential container. </p> </li> </ul>"""

condition instance-attribute

condition: NotRequired[String]

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

container_name instance-attribute

container_name: NotRequired[String]

A unique identifier for the container.