Packages

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Probe
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val exec: Optional[ExecAction]
  8. val failureThreshold: Optional[Int]
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getExec: IO[K8sFailure, ExecAction]

    Gets exec.

    Gets exec.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  11. 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.

  12. def getGrpc: IO[K8sFailure, GRPCAction]

    Gets grpc.

    Gets grpc.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  13. def getHttpGet: IO[K8sFailure, HTTPGetAction]

    Gets httpGet.

    Gets httpGet.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  14. 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.

  15. 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.

  16. 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.

  17. def getTcpSocket: IO[K8sFailure, TCPSocketAction]

    Gets tcpSocket.

    Gets tcpSocket.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  18. 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.

  19. 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.

  20. val grpc: Optional[GRPCAction]
  21. val httpGet: Optional[HTTPGetAction]
  22. val initialDelaySeconds: Optional[Int]
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. val periodSeconds: Optional[Int]
  28. val successThreshold: Optional[Int]
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. val tcpSocket: Optional[TCPSocketAction]
  31. val terminationGracePeriodSeconds: Optional[Long]
  32. val timeoutSeconds: Optional[Int]
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped