Package org.cdk8s.plus24.k8s

Class JobSpec.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<JobSpec>
    Enclosing interface:
    JobSpec
    @Stability(Stable)
public static final class JobSpec.Builder
extends Object
implements software.amazon.jsii.Builder<JobSpec>
    A builder for JobSpec

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • template

        @Stability(Stable)
public JobSpec.Builder template​(PodTemplateSpec template)
        Sets the value of JobSpec.getTemplate()
        Parameters:
        template - Describes the pod that will be created when executing a job. This parameter is required. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
        Returns:
        this

      • activeDeadlineSeconds

        @Stability(Stable)
public JobSpec.Builder activeDeadlineSeconds​(Number activeDeadlineSeconds)
        Sets the value of JobSpec.getActiveDeadlineSeconds()
        Parameters:
        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.
        Returns:
        this

      • backoffLimit

        @Stability(Stable)
public JobSpec.Builder backoffLimit​(Number backoffLimit)
        Sets the value of JobSpec.getBackoffLimit()
        Parameters:
        backoffLimit - Specifies the number of retries before marking this job failed. Defaults to 6
        Returns:
        this

      • completionMode

        @Stability(Stable)
public JobSpec.Builder completionMode​(String completionMode)
        Sets the value of JobSpec.getCompletionMode()
        Parameters:
        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).

        More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.

        Returns:
        this

      • completions

        @Stability(Stable)
public JobSpec.Builder completions​(Number completions)
        Sets the value of JobSpec.getCompletions()
        Parameters:
        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/
        Returns:
        this

      • manualSelector

        @Stability(Stable)
public JobSpec.Builder manualSelector​(Boolean manualSelector)
        Sets the value of JobSpec.getManualSelector()
        Parameters:
        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
        Returns:
        this

      • parallelism

        @Stability(Stable)
public JobSpec.Builder parallelism​(Number parallelism)
        Sets the value of JobSpec.getParallelism()
        Parameters:
        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/
        Returns:
        this

      • selector

        @Stability(Stable)
public JobSpec.Builder selector​(LabelSelector selector)
        Sets the value of JobSpec.getSelector()
        Parameters:
        selector - A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
        Returns:
        this

      • suspend

        @Stability(Stable)
public JobSpec.Builder suspend​(Boolean suspend)
        Sets the value of JobSpec.getSuspend()
        Parameters:
        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.
        Returns:
        this

      • ttlSecondsAfterFinished

        @Stability(Stable)
public JobSpec.Builder ttlSecondsAfterFinished​(Number ttlSecondsAfterFinished)
        Sets the value of JobSpec.getTtlSecondsAfterFinished()
        Parameters:
        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.
        Returns:
        this

      • build

        @Stability(Stable)
public JobSpec build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<JobSpec>
        Returns:
        a new instance of JobSpec
        Throws:
        NullPointerException - if any required attribute was not provided