ContainerHealthcheck class
Constructors
-
ContainerHealthcheck({Input<String?>? interval, Input<int?>? retries, Input<String?>? startInterval, Input<String?>? startPeriod, Input<List<String>?>? tests, Input<String?>? timeout})
-
Creates a new ContainerHealthcheck.
interval Time between running the check (ms|s|m|h). Defaults to 0s.
retries Consecutive failures needed to report unhealthy. Defaults to 0.
startInterval Interval before the healthcheck starts (ms|s|m|h). Defaults to 0s.
startPeriod Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
tests Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"]. It works in the same way, and has the same default values, as the HEALTHCHECK Dockerfile instruction set by the service's Docker image. Your Compose file can override the values set in the Dockerfile.
timeout Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.
const
-
ContainerHealthcheck.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
interval
→ Input<String?>?
-
Time between running the check (ms|s|m|h). Defaults to
0s.
final
-
retries
→ Input<int?>?
-
Consecutive failures needed to report unhealthy. Defaults to
0.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
startInterval
→ Input<String?>?
-
Interval before the healthcheck starts (ms|s|m|h). Defaults to
0s.
final
-
startPeriod
→ Input<String?>?
-
Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s.
final
-
tests
→ Input<List<String>?>?
-
Command to run to check health. For example, to run
curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"]. It works in the same way, and has the same default values, as the HEALTHCHECK Dockerfile instruction set by the service's Docker image. Your Compose file can override the values set in the Dockerfile.
final
-
timeout
→ Input<String?>?
-
Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
final
