Package org.cdk8s.plus25.k8s

Interface CronJobSpec

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CronJobSpec.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.485Z")
@Stability(Stable)
public interface CronJobSpec
extends software.amazon.jsii.JsiiSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CronJobSpec.Builder	A builder for CronJobSpec
static class	CronJobSpec.Jsii$Proxy	An implementation for CronJobSpec

Method Summary

Modifier and Type	Method	Description
static CronJobSpec.Builder	builder()
default String	getConcurrencyPolicy()	Specifies how to treat concurrent executions of a Job.
default Number	getFailedJobsHistoryLimit()	The number of failed finished jobs to retain.
JobTemplateSpec	getJobTemplate()	Specifies the job that will be created when executing a CronJob.
String	getSchedule()	The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
default Number	getStartingDeadlineSeconds()	Optional deadline in seconds for starting the job if it misses scheduled time for any reason.
default Number	getSuccessfulJobsHistoryLimit()	The number of successful finished jobs to retain.
default Boolean	getSuspend()	This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.
default String	getTimeZone()	The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJobTemplate

@Stability(Stable)
@NotNull
JobTemplateSpec getJobTemplate()

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

getSchedule

@Stability(Stable)
@NotNull
String getSchedule()

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

getConcurrencyPolicy

@Stability(Stable)
@Nullable
default String getConcurrencyPolicy()

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

getFailedJobsHistoryLimit

@Stability(Stable)
@Nullable
default Number getFailedJobsHistoryLimit()

The number of failed finished jobs to retain.

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

Default: 1.

getStartingDeadlineSeconds

@Stability(Stable)
@Nullable
default Number getStartingDeadlineSeconds()

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.

getSuccessfulJobsHistoryLimit

@Stability(Stable)
@Nullable
default Number getSuccessfulJobsHistoryLimit()

The number of successful finished jobs to retain.

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

Default: 3.

getSuspend

@Stability(Stable)
@Nullable
default Boolean getSuspend()

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

Defaults to false.

Default: false.

getTimeZone

@Stability(Stable)
@Nullable
default String getTimeZone()

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 This is beta field and must be enabled via the CronJobTimeZone feature gate.

builder

@Stability(Stable)
static CronJobSpec.Builder builder()

Returns:

a CronJobSpec.Builder of CronJobSpec