Package org.cdk8s.plus24.k8s

Interface CronJobSpecV1Beta1

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CronJobSpecV1Beta1.Jsii$Proxy

@Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-10-05T02:57:36.366Z")
@Stability(Stable)
public interface CronJobSpecV1Beta1
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	CronJobSpecV1Beta1.Builder	A builder for CronJobSpecV1Beta1
static class	CronJobSpecV1Beta1.Jsii$Proxy	An implementation for CronJobSpecV1Beta1

Method Summary

Modifier and Type	Method	Description
static CronJobSpecV1Beta1.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.
JobTemplateSpecV1Beta1	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 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
JobTemplateSpecV1Beta1 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.

This is a pointer to distinguish between explicit zero and not specified. 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.

This is a pointer to distinguish between explicit zero and not specified. 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 for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will rely on the time zone of the kube-controller-manager process. ALPHA: This field is in alpha and must be enabled via the `CronJobTimeZone` feature gate.

builder

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

Returns:

a CronJobSpecV1Beta1.Builder of CronJobSpecV1Beta1