Packages

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.

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JobSpec
  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 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)

    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.

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. val activeDeadlineSeconds: Optional[Long]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val backoffLimit: Optional[Int]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. val completionMode: Optional[String]
  9. val completions: Optional[Int]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def getActiveDeadlineSeconds: IO[K8sFailure, Long]

    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.

    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.

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

  12. def getBackoffLimit: IO[K8sFailure, Int]

    Specifies the number of retries before marking this job failed.

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

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

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def getCompletionMode: IO[K8sFailure, String]

    CompletionMode specifies how Pod completions are tracked.

    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.

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

  15. def getCompletions: IO[K8sFailure, Int]

    Specifies the desired number of successfully finished pods the job should be run with.

    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/

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

  16. def getManualSelector: IO[K8sFailure, Boolean]

    manualSelector controls generation of pod labels and pod selectors.

    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

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

  17. def getParallelism: IO[K8sFailure, Int]

    Specifies the maximum desired number of pods the job should run at any given time.

    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/

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

  18. def getSelector: IO[K8sFailure, LabelSelector]

    Gets selector.

    Gets selector.

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

  19. def getSuspend: IO[K8sFailure, Boolean]

    Suspend specifies whether the Job controller should create Pods or not.

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

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

  20. def getTemplate: IO[K8sFailure, PodTemplateSpec]

    Gets template.

    Gets template.

    This effect always succeeds, it is safe to use the field template directly.

  21. def getTtlSecondsAfterFinished: IO[K8sFailure, Int]

    ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed).

    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.

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

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val manualSelector: Optional[Boolean]
  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 parallelism: Optional[Int]
  28. val selector: Optional[LabelSelector]
  29. val suspend: Optional[Boolean]
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. val template: PodTemplateSpec
  32. val ttlSecondsAfterFinished: 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