Interface ContainerDependency.Builder

  • Method Details

    • containerName

      ContainerDependency.Builder containerName(String containerName)

      A descriptive label for the container definition that this container depends on.

      Parameters:
      containerName - A descriptive label for the container definition that this container depends on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • condition

      ContainerDependency.Builder condition(String condition)

      The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

      • START - The dependency container must have started.

      • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

      • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

      • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

      Parameters:
      condition - The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

      • START - The dependency container must have started.

      • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

      • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

      • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • condition

      The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

      • START - The dependency container must have started.

      • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

      • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

      • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

      Parameters:
      condition - The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

      • START - The dependency container must have started.

      • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

      • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

      • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: