kubernetes-models/batch/v1/CronJobSpec.d.ts

Kubernetes models

import { IIoK8sApiBatchV1JobTemplateSpec } from "./JobTemplateSpec";
import { Model } from "@kubernetes-models/base";
/**
 * CronJobSpec describes how the job execution will look like and when it will actually run.
 */
export interface ICronJobSpec {
    /**
     * 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
     *
     * Possible enum values:
     *  - `"Allow"` allows CronJobs to run concurrently.
     *  - `"Forbid"` forbids concurrent runs, skipping next run if previous hasn't finished yet.
     *  - `"Replace"` cancels currently running job and replaces it with a new one.
     */
    "concurrencyPolicy"?: "Allow" | "Forbid" | "Replace";
    /**
     * The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
     */
    "failedJobsHistoryLimit"?: number;
    /**
     * Specifies the job that will be created when executing a CronJob.
     */
    "jobTemplate": IIoK8sApiBatchV1JobTemplateSpec;
    /**
     * The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
     */
    "schedule": string;
    /**
     * 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.
     */
    "startingDeadlineSeconds"?: number;
    /**
     * The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
     */
    "successfulJobsHistoryLimit"?: number;
    /**
     * This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.  Defaults to false.
     */
    "suspend"?: boolean;
    /**
     * 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.
     */
    "timeZone"?: string;
}
/**
 * CronJobSpec describes how the job execution will look like and when it will actually run.
 */
export declare class CronJobSpec extends Model<ICronJobSpec> implements ICronJobSpec {
    "concurrencyPolicy"?: "Allow" | "Forbid" | "Replace";
    "failedJobsHistoryLimit"?: number;
    "jobTemplate": IIoK8sApiBatchV1JobTemplateSpec;
    "schedule": string;
    "startingDeadlineSeconds"?: number;
    "successfulJobsHistoryLimit"?: number;
    "suspend"?: boolean;
    "timeZone"?: string;
}
export { ICronJobSpec as IIoK8sApiBatchV1CronJobSpec, CronJobSpec as IoK8sApiBatchV1CronJobSpec };