DockerCreateContainer.HealthCheckConfig (gradle-docker-plugin 9.3.0 API)

java.lang.Object
- com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.HealthCheckConfig

Enclosing class:: DockerCreateContainer

public static class DockerCreateContainer.HealthCheckConfig
extends Object

Since:: 6.7.0

Constructor Summary

Constructors
Constructor Description

HealthCheckConfig(ObjectFactory objectFactory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cmd(String shellCommand)`
`ListProperty<String>`	`getCmd()`
`Property<Long>`	`getInterval()`	The time to wait between checks in nanoseconds.
`Property<Integer>`	`getRetries()`	The number of consecutive failures needed to consider a container as unhealthy.
`Property<Long>`	`getStartPeriod()`	The time to wait for container initialization before starting health-retries countdown in nanoseconds.
`Property<Long>`	`getTimeout()`	The time to wait before considering the check to have hung.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HealthCheckConfig
```
@Inject
public HealthCheckConfig(ObjectFactory objectFactory)
```
- Method Detail
  - getInterval
```
@Input
@Optional
public final Property<Long> getInterval()
```
    The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
  - getTimeout
```
@Input
@Optional
public final Property<Long> getTimeout()
```
    The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
  - getCmd
```
@Input
@Optional
public final ListProperty<String> getCmd()
```
  - getRetries
```
@Input
@Optional
public final Property<Integer> getRetries()
```
    The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
  - getStartPeriod
```
@Input
@Optional
public final Property<Long> getStartPeriod()
```
    The time to wait for container initialization before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
  - cmd
```
public void cmd(String shellCommand)
```