zio-k8s-client/com.coralogix.zio.k8s.model.batch.v1

com.coralogix.zio.k8s.model.batch.v1

package com.coralogix.zio.k8s.model.batch.v1

Type members

Classlikes

case class Job(metadata: Optional[ObjectMeta], spec: Optional[JobSpec], status: Optional[JobStatus])

Job represents the configuration of a single job.

Job represents the configuration of a single job.

Companion
object
object Job extends JobFields
Companion
class
case class JobCondition(lastProbeTime: Optional[Time], lastTransitionTime: Optional[Time], message: Optional[String], reason: Optional[String], status: String, `type`: String)

JobCondition describes current state of a job.

JobCondition describes current state of a job.

Value Params
message

Human readable message indicating details about last transition.

reason

(brief) reason for the condition's last transition.

status

Status of the condition, one of True, False, Unknown.

type

Type of job condition, Complete or Failed.

Companion
object
object JobCondition extends JobConditionFields
Companion
class
class JobConditionFields(_prefix: Chunk[String])
class JobFields(_prefix: Chunk[String])
case class JobSpec(activeDeadlineSeconds: Optional[Long], backoffLimit: Optional[Int], completions: Optional[Int], manualSelector: Optional[Boolean], parallelism: Optional[Int], selector: Optional[LabelSelector], template: PodTemplateSpec, ttlSecondsAfterFinished: Optional[Int])

JobSpec describes how the job execution will look like.

JobSpec describes how the job execution will look like.

Value Params
activeDeadlineSeconds

Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

backoffLimit

Specifies the number of retries before marking this job failed. Defaults to 6

completions

Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

manualSelector

manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

parallelism

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

ttlSecondsAfterFinished

ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.

Companion
object
object JobSpec extends JobSpecFields
Companion
class
class JobSpecFields(_prefix: Chunk[String])
case class JobStatus(active: Optional[Int], completionTime: Optional[Time], conditions: Optional[Vector[JobCondition]], failed: Optional[Int], startTime: Optional[Time], succeeded: Optional[Int])

JobStatus represents the current state of a Job.

JobStatus represents the current state of a Job.

Value Params
active

The number of actively running pods.

conditions

The latest available observations of an object's current state. When a job fails, one of the conditions will have type == "Failed". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

failed

The number of pods which reached phase Failed.

succeeded

The number of pods which reached phase Succeeded.

Companion
object
object JobStatus extends JobStatusFields
Companion
class
class JobStatusFields(_prefix: Chunk[String])