Struct CronJobSpec

pub struct CronJobSpec {
    pub concurrency_policy: Option<String>,
    pub failed_jobs_history_limit: Option<i32>,
    pub job_template: JobTemplateSpec,
    pub schedule: String,
    pub starting_deadline_seconds: Option<i64>,
    pub successful_jobs_history_limit: Option<i32>,
    pub suspend: Option<bool>,
    pub time_zone: Option<String>,
}

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

Fields

concurrency_policy: Option<String>

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

failed_jobs_history_limit: Option<i32>

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

job_template: JobTemplateSpec

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

schedule: String

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

starting_deadline_seconds: Option<i64>

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.

successful_jobs_history_limit: Option<i32>

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

suspend: Option<bool>

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

time_zone: Option<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

Trait Implementations

impl Clone for CronJobSpec

fn clone(&self) -> CronJobSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CronJobSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeepMerge for CronJobSpec

fn merge_from(&mut self, other: Self)

Merge other into self.

impl Default for CronJobSpec

fn default() -> CronJobSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CronJobSpec

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CronJobSpec

fn eq(&self, other: &CronJobSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CronJobSpec

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CronJobSpec