CronJobSpec class

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

Constructors

CronJobSpec({String? concurrencyPolicy, int? failedJobsHistoryLimit, required JobTemplateSpec jobTemplate, required String schedule, int? startingDeadlineSeconds, int? successfulJobsHistoryLimit, bool? suspend, String? timeZone})

Default constructor.

const

CronJobSpec.fromJson(Map<String, dynamic> json)

Creates a CronJobSpec from JSON data.

factory

Properties

concurrencyPolicy → String?

Specifies how to treat concurrent executions of a Job. Valid values are:

final

failedJobsHistoryLimit → int?

The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.

final

hashCode → int

The hash code for this object.

no setter, inherited

jobTemplate → JobTemplateSpec

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schedule → String

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

final

startingDeadlineSeconds → int?

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.

final

successfulJobsHistoryLimit → int?

The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

final

suspend → bool?

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

final

timeZone → String?

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object>

Converts a CronJobSpec instance to JSON data.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited