case class HealthCheck(command: String, interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None) extends DockerfileInstruction with Product with Serializable

Defines health check command to run inside the container to check that it is still working.

command

Command to execute for health check

interval

The health check will first run interval seconds after the container is started, and then again interval seconds after each previous check completes.

timeout

If a single run of the check takes longer than specified then the check is considered to have failed.

startPeriod

Provides initialization time for containers that need time to bootstrap.

retries

How many consecutive failures of the health check for the container to be considered unhealthy.

Linear Supertypes
Serializable, Serializable, Product, Equals, DockerfileInstruction, Instruction, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HealthCheck
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DockerfileInstruction
  7. Instruction
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HealthCheck(command: String, interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None)

    command

    Command to execute for health check

    interval

    The health check will first run interval seconds after the container is started, and then again interval seconds after each previous check completes.

    timeout

    If a single run of the check takes longer than specified then the check is considered to have failed.

    startPeriod

    Provides initialization time for containers that need time to bootstrap.

    retries

    How many consecutive failures of the health check for the container to be considered unhealthy.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def arguments: String
    Definition Classes
    HealthCheck → DockerfileInstruction
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val command: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def instructionName: String
    Definition Classes
    HealthCheck → DockerfileInstruction
  11. val interval: Option[FiniteDuration]
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val retries: Option[Int]
  17. val startPeriod: Option[FiniteDuration]
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val timeout: Option[FiniteDuration]
  20. def toString(): String
    Definition Classes
    DockerfileInstruction → AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def toInstructionString: String
    Definition Classes
    DockerfileInstruction
    Annotations
    @deprecated
    Deprecated

    (Since version 0.4.0) Use toString instead.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DockerfileInstruction

Inherited from Instruction

Inherited from AnyRef

Inherited from Any

Ungrouped