Package io.quarkus.kubernetes.deployment

Class ProbeConfig

java.lang.Object

io.quarkus.kubernetes.deployment.ProbeConfig

public class ProbeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Optional<String>	execAction	The command to use for the probe.
(package private) Integer	failureThreshold	The failure threshold to use.
(package private) Optional<String>	httpActionPath	The http path to use for the probe For this to work, the container port also needs to be set.
(package private) Duration	initialDelay	The amount of time to wait before starting to probe.
(package private) Duration	period	The period in which the action should be called.
(package private) Integer	successThreshold	The success threshold to use.
(package private) Optional<String>	tcpSocketAction	The tcp socket to use for the probe (the format is host:port).
(package private) Duration	timeout	The amount of time to wait for each action.

Constructor Summary

Constructors

Constructor	Description
ProbeConfig()

Method Summary

Modifier and Type	Method	Description
boolean	hasUserSuppliedAction()

Methods inherited from class java.lang.Object

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

Field Detail

httpActionPath

@ConfigItem
Optional<String> httpActionPath

The http path to use for the probe For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

execAction

@ConfigItem
Optional<String> execAction

The command to use for the probe.

tcpSocketAction

@ConfigItem
Optional<String> tcpSocketAction

The tcp socket to use for the probe (the format is host:port).

initialDelay

@ConfigItem(defaultValue="5")
Duration initialDelay

The amount of time to wait before starting to probe.

period

@ConfigItem(defaultValue="10s")
Duration period

The period in which the action should be called.

timeout

@ConfigItem(defaultValue="10s")
Duration timeout

The amount of time to wait for each action.

successThreshold

@ConfigItem(defaultValue="1")
Integer successThreshold

The success threshold to use.

failureThreshold

@ConfigItem(defaultValue="3")
Integer failureThreshold

The failure threshold to use.

Constructor Detail

ProbeConfig

public ProbeConfig()

Method Detail

hasUserSuppliedAction

public boolean hasUserSuppliedAction()