HealthConfig
Table of Contents
- $interval : int|null
- The time to wait between checks in nanoseconds. It should be 0 or at.
- $retries : int|null
- The number of consecutive failures needed to consider a container as.
- $startPeriod : int|null
- Start period for the container to initialize before starting.
- $test : array<string|int, string>|null
- The test to perform. Possible values are:.
- $timeout : int|null
- The time to wait before considering the check to have hung. It should.
- getInterval() : int|null
- The time to wait between checks in nanoseconds. It should be 0 or at.
- getRetries() : int|null
- The number of consecutive failures needed to consider a container as.
- getStartPeriod() : int|null
- Start period for the container to initialize before starting.
- getTest() : array<string|int, string>|null
- The test to perform. Possible values are:.
- getTimeout() : int|null
- The time to wait before considering the check to have hung. It should.
- setInterval() : self
- The time to wait between checks in nanoseconds. It should be 0 or at.
- setRetries() : self
- The number of consecutive failures needed to consider a container as.
- setStartPeriod() : self
- Start period for the container to initialize before starting.
- setTest() : self
- The test to perform. Possible values are:.
- setTimeout() : self
- The time to wait before considering the check to have hung. It should.
Properties
$interval
The time to wait between checks in nanoseconds. It should be 0 or at.
protected
int|null
$interval
$retries
The number of consecutive failures needed to consider a container as.
protected
int|null
$retries
$startPeriod
Start period for the container to initialize before starting.
protected
int|null
$startPeriod
$test
The test to perform. Possible values are:.
protected
array<string|int, string>|null
$test
$timeout
The time to wait before considering the check to have hung. It should.
protected
int|null
$timeout
Methods
getInterval()
The time to wait between checks in nanoseconds. It should be 0 or at.
public
getInterval() : int|null
least 1000000 (1 ms). 0 means inherit.
Return values
int|null —getRetries()
The number of consecutive failures needed to consider a container as.
public
getRetries() : int|null
unhealthy. 0 means inherit.
Return values
int|null —getStartPeriod()
Start period for the container to initialize before starting.
public
getStartPeriod() : int|null
1000000 (1 ms). 0 means inherit.
Return values
int|null —getTest()
The test to perform. Possible values are:.
public
getTest() : array<string|int, string>|null
Return values
array<string|int, string>|null —getTimeout()
The time to wait before considering the check to have hung. It should.
public
getTimeout() : int|null
be 0 or at least 1000000 (1 ms). 0 means inherit.
Return values
int|null —setInterval()
The time to wait between checks in nanoseconds. It should be 0 or at.
public
setInterval(int|null $interval) : self
least 1000000 (1 ms). 0 means inherit.
Parameters
- $interval : int|null
Return values
self —setRetries()
The number of consecutive failures needed to consider a container as.
public
setRetries(int|null $retries) : self
unhealthy. 0 means inherit.
Parameters
- $retries : int|null
Return values
self —setStartPeriod()
Start period for the container to initialize before starting.
public
setStartPeriod(int|null $startPeriod) : self
1000000 (1 ms). 0 means inherit.
Parameters
- $startPeriod : int|null
Return values
self —setTest()
The test to perform. Possible values are:.
public
setTest(array<string|int, string>|null $test) : self
Parameters
- $test : array<string|int, string>|null
Return values
self —setTimeout()
The time to wait before considering the check to have hung. It should.
public
setTimeout(int|null $timeout) : self
be 0 or at least 1000000 (1 ms). 0 means inherit.
Parameters
- $timeout : int|null