case class Probe(exec: Option[ExecAction] = None, failureThreshold: Option[Int] = None, grpc: Option[GRPCAction] = None, httpGet: Option[HTTPGetAction] = None, initialDelaySeconds: Option[Int] = None, periodSeconds: Option[Int] = None, successThreshold: Option[Int] = None, tcpSocket: Option[TCPSocketAction] = None, terminationGracePeriodSeconds: Option[Long] = None, timeoutSeconds: Option[Int] = None) extends Product with Serializable
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
- exec
Exec specifies the action to take.
- failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- grpc
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
- httpGet
HTTPGet specifies the http request to perform.
- initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- tcpSocket
TCPSocket specifies an action involving a TCP port.
- terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset
- timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- Alphabetic
- By Inheritance
- Probe
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Probe(exec: Option[ExecAction] = None, failureThreshold: Option[Int] = None, grpc: Option[GRPCAction] = None, httpGet: Option[HTTPGetAction] = None, initialDelaySeconds: Option[Int] = None, periodSeconds: Option[Int] = None, successThreshold: Option[Int] = None, tcpSocket: Option[TCPSocketAction] = None, terminationGracePeriodSeconds: Option[Long] = None, timeoutSeconds: Option[Int] = None)
- exec
Exec specifies the action to take.
- failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- grpc
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
- httpGet
HTTPGet specifies the http request to perform.
- initialDelaySeconds
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- periodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- tcpSocket
TCPSocket specifies an action involving a TCP port.
- terminationGracePeriodSeconds
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset
- timeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val exec: Option[ExecAction]
- val failureThreshold: Option[Int]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val grpc: Option[GRPCAction]
- val httpGet: Option[HTTPGetAction]
- val initialDelaySeconds: Option[Int]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val periodSeconds: Option[Int]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val successThreshold: Option[Int]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tcpSocket: Option[TCPSocketAction]
- val terminationGracePeriodSeconds: Option[Long]
- val timeoutSeconds: Option[Int]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated