Type Members

1.  case class CronJob(metadata: Optional[ObjectMeta] = Optional.Absent, spec: Optional[CronJobSpec] = Optional.Absent, status: Optional[CronJobStatus] = Optional.Absent) extends Product with Serializable

   CronJob represents the configuration of a single cron job.

2.  class CronJobFields extends AnyRef
3.  case class CronJobSpec(concurrencyPolicy: Optional[String] = Optional.Absent, failedJobsHistoryLimit: Optional[Int] = Optional.Absent, jobTemplate: JobTemplateSpec, schedule: String, startingDeadlineSeconds: Optional[Long] = Optional.Absent, successfulJobsHistoryLimit: Optional[Int] = Optional.Absent, suspend: Optional[Boolean] = Optional.Absent) extends Product with Serializable

   CronJobSpec describes how the job execution will look like and when it will actually run.

   CronJobSpec describes how the job execution will look like and when it will actually run.

   concurrencyPolicy

   Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one

   failedJobsHistoryLimit

   The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to \1.

   schedule

   The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

   startingDeadlineSeconds

   Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

   successfulJobsHistoryLimit

   The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

   suspend

   This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

4.  class CronJobSpecFields extends AnyRef
5.  case class CronJobStatus(active: Optional[Vector[ObjectReference]] = Optional.Absent, lastScheduleTime: Optional[Time] = Optional.Absent, lastSuccessfulTime: Optional[Time] = Optional.Absent) extends Product with Serializable

   CronJobStatus represents the current state of a cron job.

   CronJobStatus represents the current state of a cron job.

   active

   A list of pointers to currently running jobs.

6.  class CronJobStatusFields extends AnyRef
7.  case class Job(metadata: Optional[ObjectMeta] = Optional.Absent, spec: Optional[JobSpec] = Optional.Absent, status: Optional[JobStatus] = Optional.Absent) extends Product with Serializable

   Job represents the configuration of a single job.

8.  case class JobCondition(lastProbeTime: Optional[Time] = Optional.Absent, lastTransitionTime: Optional[Time] = Optional.Absent, message: Optional[String] = Optional.Absent, reason: Optional[String] = Optional.Absent, status: String, type: String) extends Product with Serializable

   JobCondition describes current state of a job.

   JobCondition describes current state of a job.

   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.

9.  class JobConditionFields extends AnyRef
10.  class JobFields extends AnyRef
11.  case class JobSpec(activeDeadlineSeconds: Optional[Long] = Optional.Absent, backoffLimit: Optional[Int] = Optional.Absent, completionMode: Optional[String] = Optional.Absent, completions: Optional[Int] = Optional.Absent, manualSelector: Optional[Boolean] = Optional.Absent, parallelism: Optional[Int] = Optional.Absent, selector: Optional[LabelSelector] = Optional.Absent, suspend: Optional[Boolean] = Optional.Absent, template: PodTemplateSpec, ttlSecondsAfterFinished: Optional[Int] = Optional.Absent) extends Product with Serializable

    JobSpec describes how the job execution will look like.

    JobSpec describes how the job execution will look like.

    activeDeadlineSeconds

    Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.

    backoffLimit

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

    completionMode

    CompletionMode specifies how Pod completions are tracked. It can be NonIndexed (default) or Indexed. NonIndexed means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. Indexed means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is Indexed, .spec.completions must be specified and .spec.parallelism must be less than or equal to 10^5. In addition, The Pod name takes the form $$(job-name)-$$(index)-$$(random-string), the Pod hostname takes the form $$(job-name)-$$(index). This field is beta-level. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job.

    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/

    suspend

    Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. This field is beta-level, gated by SuspendJob feature flag (enabled by default).

    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.

12.  class JobSpecFields extends AnyRef
13.  case class JobStatus(active: Optional[Int] = Optional.Absent, completedIndexes: Optional[String] = Optional.Absent, completionTime: Optional[Time] = Optional.Absent, conditions: Optional[Vector[JobCondition]] = Optional.Absent, failed: Optional[Int] = Optional.Absent, ready: Optional[Int] = Optional.Absent, startTime: Optional[Time] = Optional.Absent, succeeded: Optional[Int] = Optional.Absent, uncountedTerminatedPods: Optional[UncountedTerminatedPods] = Optional.Absent) extends Product with Serializable

    JobStatus represents the current state of a Job.

    JobStatus represents the current state of a Job.

    active

    The number of pending and running pods.

    completedIndexes

    CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".

    conditions

    The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

    failed

    The number of pods which reached phase Failed.

    ready

    The number of pods which have a Ready condition. This field is alpha-level. The job controller populates the field when the feature gate JobReadyPods is enabled (disabled by default).

    succeeded

    The number of pods which reached phase Succeeded.

14.  class JobStatusFields extends AnyRef
15.  case class JobTemplateSpec(metadata: Optional[ObjectMeta] = Optional.Absent, spec: Optional[JobSpec] = Optional.Absent) extends Product with Serializable

    JobTemplateSpec describes the data a Job should have when created from a template

16.  class JobTemplateSpecFields extends AnyRef
17.  case class UncountedTerminatedPods(failed: Optional[Vector[String]] = Optional.Absent, succeeded: Optional[Vector[String]] = Optional.Absent) extends Product with Serializable

    UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.

    UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.

    failed

    Failed holds UIDs of failed Pods.

    succeeded

    Succeeded holds UIDs of succeeded Pods.

18.  class UncountedTerminatedPodsFields extends AnyRef