Package com.google.cloud.tools.jib.configuration

Class DockerHealthCheck

java.lang.Object

com.google.cloud.tools.jib.configuration.DockerHealthCheck

public class DockerHealthCheck
extends java.lang.Object

Configuration information for performing healthchecks on a Docker container.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerHealthCheck.Builder	Builds the immutable DockerHealthCheck.

Method Summary

Modifier and Type	Method	Description
static DockerHealthCheck.Builder	fromCommand(java.util.List<java.lang.String> command)	Creates a new DockerHealthCheck.Builder with the specified command.
java.util.List<java.lang.String>	getCommand()	Gets the optional healthcheck command.
java.util.Optional<java.time.Duration>	getInterval()	Gets the optional healthcheck interval.
java.util.Optional<java.lang.Integer>	getRetries()	Gets the optional healthcheck retry count.
java.util.Optional<java.time.Duration>	getStartPeriod()	Gets the optional healthcheck start period.
java.util.Optional<java.time.Duration>	getTimeout()	Gets the optional healthcheck timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromCommand

public static DockerHealthCheck.Builder fromCommand(java.util.List<java.lang.String> command)

Creates a new DockerHealthCheck.Builder with the specified command.

Parameters:

command - the command

Returns:

a new DockerHealthCheck.Builder

getCommand

public java.util.List<java.lang.String> getCommand()

Gets the optional healthcheck command. A missing command means that it will be inherited from the base image.

Returns:

the healthcheck command

getInterval

public java.util.Optional<java.time.Duration> getInterval()

Gets the optional healthcheck interval. A missing command means that it will be inherited from the base image.

Returns:

the healthcheck interval

getTimeout

public java.util.Optional<java.time.Duration> getTimeout()

Gets the optional healthcheck timeout. A missing command means that it will be inherited from the base image.

Returns:

the healthcheck timeout

getStartPeriod

public java.util.Optional<java.time.Duration> getStartPeriod()

Gets the optional healthcheck start period. A missing command means that it will be inherited from the base image.

Returns:

the healthcheck start period

getRetries

public java.util.Optional<java.lang.Integer> getRetries()

Gets the optional healthcheck retry count. A missing command means that it will be inherited from the base image.

Returns:

the healthcheck retry count