Packages > pkg.pkl-lang.org/pkl-k8s/k8s > k8s.api.batch.v1.CronJob

CronJobSpec1.2.1

Properties
Methods

class CronJobSpec

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

Known subtypes:
Known usages:: CronJob
All versions:: 1.2.1, 1.2.0, 1.1.3, 1.1.2, 1.1.1, 1.1.0, 1.0.1

Properties

link

suspend: Boolean?Source

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

Defaults to false.
link

schedule: String Source

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

jobTemplate: JobTemplateSpec Source

Specifies the job that will be created when executing a CronJob.
link

startingDeadlineSeconds: Int?Source

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.
link
concurrencyPolicy: String?Source

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
link

timeZone: String?Source

The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
link

failedJobsHistoryLimit: Int32?Source

The number of failed finished jobs to retain.

Value must be non-negative integer. Defaults to 1.
link

successfulJobsHistoryLimit: Int32?Source

The number of successful finished jobs to retain.

Value must be non-negative integer. Defaults to 3.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.