case class Probe(exec: Optional[ExecAction] = Optional.Absent, failureThreshold: Optional[Int] = Optional.Absent, grpc: Optional[GRPCAction] = Optional.Absent, httpGet: Optional[HTTPGetAction] = Optional.Absent, initialDelaySeconds: Optional[Int] = Optional.Absent, periodSeconds: Optional[Int] = Optional.Absent, successThreshold: Optional[Int] = Optional.Absent, tcpSocket: Optional[TCPSocketAction] = Optional.Absent, terminationGracePeriodSeconds: Optional[Long] = Optional.Absent, timeoutSeconds: Optional[Int] = Optional.Absent) 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.
- failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- 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.
- 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
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Probe(exec: Optional[ExecAction] = Optional.Absent, failureThreshold: Optional[Int] = Optional.Absent, grpc: Optional[GRPCAction] = Optional.Absent, httpGet: Optional[HTTPGetAction] = Optional.Absent, initialDelaySeconds: Optional[Int] = Optional.Absent, periodSeconds: Optional[Int] = Optional.Absent, successThreshold: Optional[Int] = Optional.Absent, tcpSocket: Optional[TCPSocketAction] = Optional.Absent, terminationGracePeriodSeconds: Optional[Long] = Optional.Absent, timeoutSeconds: Optional[Int] = Optional.Absent)
- failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- 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.
- 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( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val exec: Optional[ExecAction]
- val failureThreshold: Optional[Int]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getExec: IO[K8sFailure, ExecAction]
Gets exec.
Gets exec.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getFailureThreshold: IO[K8sFailure, Int]
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getGrpc: IO[K8sFailure, GRPCAction]
Gets grpc.
Gets grpc.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getHttpGet: IO[K8sFailure, HTTPGetAction]
Gets httpGet.
Gets httpGet.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getInitialDelaySeconds: IO[K8sFailure, Int]
Number of seconds after the container has started before liveness probes are initiated.
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
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getPeriodSeconds: IO[K8sFailure, Int]
How often (in seconds) to perform the probe.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getSuccessThreshold: IO[K8sFailure, Int]
Minimum consecutive successes for the probe to be considered successful after having failed.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTcpSocket: IO[K8sFailure, TCPSocketAction]
Gets tcpSocket.
Gets tcpSocket.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTerminationGracePeriodSeconds: IO[K8sFailure, Long]
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTimeoutSeconds: IO[K8sFailure, Int]
Number of seconds after which the probe times out.
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
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
- val grpc: Optional[GRPCAction]
- val httpGet: Optional[HTTPGetAction]
- val initialDelaySeconds: Optional[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: Optional[Int]
- val successThreshold: Optional[Int]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val tcpSocket: Optional[TCPSocketAction]
- val terminationGracePeriodSeconds: Optional[Long]
- val timeoutSeconds: Optional[Int]
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )