Module batch/v2alpha1

@pulumi/kubernetes > batch > v2alpha1

Index

types/input.ts types/output.ts

function isCronJob

isCronJob(o: any): boolean

function isCronJobList

isCronJobList(o: any): boolean

interface CronJob

CronJob represents the configuration of a single cron job.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

spec: CronJobSpec;

Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

status: CronJobStatus;

Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface CronJobList

CronJobList is a collection of cron jobs.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: CronJob[];

items is the list of CronJobs.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

interface CronJobSpec

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

property concurrencyPolicy

concurrencyPolicy: 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

property failedJobsHistoryLimit

failedJobsHistoryLimit: number;

The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.

property jobTemplate

jobTemplate: JobTemplateSpec;

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

property schedule

schedule: string;

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

property startingDeadlineSeconds

startingDeadlineSeconds: number;

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.

property successfulJobsHistoryLimit

successfulJobsHistoryLimit: number;

The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.

property suspend

suspend: boolean;

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

interface CronJobStatus

CronJobStatus represents the current state of a cron job.

property active

active: ObjectReference[];

A list of pointers to currently running jobs.

property lastScheduleTime

lastScheduleTime: string;

Information when was the last time the job was successfully scheduled.

interface JobTemplateSpec

JobTemplateSpec describes the data a Job should have when created from a template

property metadata

metadata: ObjectMeta;

Standard object’s metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

spec: JobSpec;

Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status