class HealthcheckConfig extends AbstractObject implements IdAble

Image healthcheck configuration.

Properties

$lastQuery from  AbstractObject

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

array
args()

Healthcheck command arguments.

id()

A unique identifier for this HealthcheckConfig.

string
interval()

Interval between running healthcheck. Example:30s

int
retries()

The maximum number of consecutive failures before the container is marked as unhealthy. Example:3

bool
shell()

Healthcheck command is a shell command.

string
startInterval()

StartInterval configures the duration between checks during the startup phase. Example:5s

string
startPeriod()

StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s

string
timeout()

Healthcheck timeout. Example:3s

Details

in AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

AbstractClient $client
QueryBuilderChain $queryBuilderChain

in AbstractObject at line 19
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

QueryBuilder $leafQueryBuilder
string $leafKey

Return Value

null|array|string|int|float|bool

at line 19
array args()

Healthcheck command arguments.

Return Value

array

at line 28
AbstractId id()

A unique identifier for this HealthcheckConfig.

Return Value

AbstractId

at line 37
string interval()

Interval between running healthcheck. Example:30s

Return Value

string

at line 46
int retries()

The maximum number of consecutive failures before the container is marked as unhealthy. Example:3

Return Value

int

at line 55
bool shell()

Healthcheck command is a shell command.

Return Value

bool

at line 64
string startInterval()

StartInterval configures the duration between checks during the startup phase. Example:5s

Return Value

string

at line 73
string startPeriod()

StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s

Return Value

string

at line 82
string timeout()

Healthcheck timeout. Example:3s

Return Value

string